diff --git a/docs/nevermined-sdk/api-reference/classes/AccessCondition.md b/docs/nevermined-sdk/api-reference/classes/AccessCondition.md index ba8d60924f..f11b133da1 100644 --- a/docs/nevermined-sdk/api-reference/classes/AccessCondition.md +++ b/docs/nevermined-sdk/api-reference/classes/AccessCondition.md @@ -74,8 +74,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -88,7 +88,7 @@ ProviderCondition\.constructor #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -102,9 +102,9 @@ ProviderCondition.address #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -116,9 +116,9 @@ ProviderCondition.contract #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -130,9 +130,9 @@ ProviderCondition.contractName #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -144,9 +144,9 @@ ProviderCondition.events #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -158,7 +158,7 @@ ProviderCondition.version #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -176,9 +176,9 @@ ProviderCondition.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -194,9 +194,9 @@ ProviderCondition.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -212,9 +212,9 @@ ProviderCondition.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -230,9 +230,9 @@ ProviderCondition.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -248,9 +248,9 @@ ProviderCondition.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -266,9 +266,9 @@ ProviderCondition.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -284,9 +284,9 @@ ProviderCondition.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -302,9 +302,9 @@ ProviderCondition.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -314,69 +314,69 @@ ProviderCondition.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -384,9 +384,9 @@ ProviderCondition.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -396,38 +396,38 @@ ProviderCondition.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -435,7 +435,7 @@ ProviderCondition.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -445,11 +445,11 @@ ProviderCondition.walletClient #### Parameters -| Name | Type | -| :------------ | :---------------------------------------------- | -| `conditionId` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `conditionId` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -461,9 +461,9 @@ ProviderCondition.abortByTimeOut #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L75) +[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L75) ---- +___ ### call @@ -472,16 +472,16 @@ ProviderCondition.abortByTimeOut #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -493,9 +493,9 @@ ProviderCondition.call #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### checkPermissions @@ -503,11 +503,11 @@ ProviderCondition.call #### Parameters -| Name | Type | -| :-------- | :---------------------------- | -| `grantee` | `string` | -| `did` | `string` | -| `from?` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `grantee` | `string` | +| `did` | `string` | +| `from?` | [`NvmAccount`](NvmAccount.md) | #### Returns @@ -515,9 +515,9 @@ ProviderCondition.call #### Defined in -[src/keeper/contracts/conditions/AccessCondition.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/AccessCondition.ts#L39) +[src/keeper/contracts/conditions/AccessCondition.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/AccessCondition.ts#L39) ---- +___ ### fulfill @@ -525,13 +525,13 @@ ProviderCondition.call #### Parameters -| Name | Type | -| :------------ | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `grantee` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `grantee` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -543,9 +543,9 @@ ProviderCondition.fulfill #### Defined in -[src/keeper/contracts/conditions/AccessCondition.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/AccessCondition.ts#L29) +[src/keeper/contracts/conditions/AccessCondition.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/AccessCondition.ts#L29) ---- +___ ### fulfillInstance @@ -553,13 +553,13 @@ ProviderCondition.fulfill #### Parameters -| Name | Type | Default value | -| :----------------- | :-------------------------------------------------------- | :------------ | -| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -571,9 +571,9 @@ ProviderCondition.fulfillInstance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L139) +[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L139) ---- +___ ### fulfillPlain @@ -581,13 +581,13 @@ ProviderCondition.fulfillInstance #### Parameters -| Name | Type | Default value | -| :------------ | :-------------------------------------------------------- | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -599,9 +599,9 @@ ProviderCondition.fulfillPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L47) +[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L47) ---- +___ ### fulfillWithNode @@ -609,12 +609,12 @@ ProviderCondition.fulfillPlain #### Parameters -| Name | Type | -| :----------------- | :----------------------------------------------------- | -| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | -| `additionalParams` | `Record`\<`string`, `unknown`\> | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | +| `additionalParams` | `Record`\<`string`, `unknown`\> | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -626,9 +626,9 @@ ProviderCondition.fulfillWithNode #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L183) +[src/keeper/contracts/conditions/Condition.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L183) ---- +___ ### generateId @@ -636,10 +636,10 @@ ProviderCondition.fulfillWithNode #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -651,9 +651,9 @@ ProviderCondition.generateId #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L61) +[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L61) ---- +___ ### generateIdHash @@ -661,10 +661,10 @@ ProviderCondition.generateId #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `...values` | `any`[] | +| `...values` | `any`[] | #### Returns @@ -676,9 +676,9 @@ ProviderCondition.generateIdHash #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L57) +[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L57) ---- +___ ### generateIdWithSeed @@ -686,10 +686,10 @@ ProviderCondition.generateIdHash #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -701,9 +701,9 @@ ProviderCondition.generateIdWithSeed #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L65) +[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L65) ---- +___ ### getConditionFulfilledEvent @@ -711,8 +711,8 @@ ProviderCondition.generateIdWithSeed #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns @@ -725,9 +725,9 @@ ProviderCondition.getConditionFulfilledEvent #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L79) +[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L79) ---- +___ ### getFromAddress @@ -735,8 +735,8 @@ ProviderCondition.getConditionFulfilledEvent #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -749,44 +749,44 @@ ProviderCondition.getFromAddress #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getGrantedDidByConsumer -▸ **getGrantedDidByConsumer**(`consumer`): `Promise`\<\{ `agreementId`: `string` ; `did`: `string` }[]\> +▸ **getGrantedDidByConsumer**(`consumer`): `Promise`\<\{ `agreementId`: `string` ; `did`: `string` }[]\> #### Parameters -| Name | Type | -| :--------- | :------- | +| Name | Type | +| :------ | :------ | | `consumer` | `string` | #### Returns -`Promise`\<\{ `agreementId`: `string` ; `did`: `string` }[]\> +`Promise`\<\{ `agreementId`: `string` ; `did`: `string` }[]\> #### Defined in -[src/keeper/contracts/conditions/AccessCondition.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/AccessCondition.ts#L47) +[src/keeper/contracts/conditions/AccessCondition.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/AccessCondition.ts#L47) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -794,9 +794,9 @@ ProviderCondition.getTransactionLogs #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### hashValues @@ -804,8 +804,8 @@ ProviderCondition.getTransactionLogs #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -818,9 +818,9 @@ ProviderCondition.hashValues #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L116) +[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L116) ---- +___ ### hashValuesPlain @@ -828,8 +828,8 @@ ProviderCondition.hashValues #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -842,9 +842,9 @@ ProviderCondition.hashValuesPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L122) +[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L122) ---- +___ ### init @@ -852,11 +852,11 @@ ProviderCondition.hashValuesPlain #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -868,9 +868,9 @@ ProviderCondition.init #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instance @@ -878,10 +878,10 @@ ProviderCondition.init #### Parameters -| Name | Type | -| :------------ | :------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | #### Returns @@ -893,9 +893,9 @@ ProviderCondition.instance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L163) +[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L163) ---- +___ ### instanceFromDDO @@ -903,11 +903,11 @@ ProviderCondition.instance #### Parameters -| Name | Type | -| :------------ | :-------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `AccessConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `ctx` | `AccessConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | #### Returns @@ -919,9 +919,9 @@ ProviderCondition.instanceFromDDO #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L131) +[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L131) ---- +___ ### nodeMethod @@ -937,9 +937,9 @@ ProviderCondition.nodeMethod #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L200) +[src/keeper/contracts/conditions/Condition.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L200) ---- +___ ### params @@ -947,9 +947,9 @@ ProviderCondition.nodeMethod #### Parameters -| Name | Type | -| :-------- | :------- | -| `did` | `string` | +| Name | Type | +| :------ | :------ | +| `did` | `string` | | `grantee` | `string` | #### Returns @@ -962,9 +962,9 @@ ProviderCondition.params #### Defined in -[src/keeper/contracts/conditions/AccessCondition.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/AccessCondition.ts#L21) +[src/keeper/contracts/conditions/AccessCondition.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/AccessCondition.ts#L21) ---- +___ ### paramsFromDDO @@ -972,8 +972,8 @@ ProviderCondition.params #### Parameters -| Name | Type | -| :--------------- | :----------------------- | +| Name | Type | +| :------ | :------ | | `«destructured»` | `AccessConditionContext` | #### Returns @@ -986,9 +986,9 @@ ProviderCondition.paramsFromDDO #### Defined in -[src/keeper/contracts/conditions/AccessCondition.ts:25](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/AccessCondition.ts#L25) +[src/keeper/contracts/conditions/AccessCondition.ts:25](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/AccessCondition.ts#L25) ---- +___ ### send @@ -996,12 +996,12 @@ ProviderCondition.paramsFromDDO #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1013,9 +1013,9 @@ ProviderCondition.send #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -1023,12 +1023,12 @@ ProviderCondition.send #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1040,9 +1040,9 @@ ProviderCondition.sendFrom #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -1050,8 +1050,8 @@ ProviderCondition.sendFrom #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1064,9 +1064,9 @@ ProviderCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1074,8 +1074,8 @@ ProviderCondition.setInstanceConfig #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1088,9 +1088,9 @@ ProviderCondition.someLog #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -1098,8 +1098,8 @@ ProviderCondition.someLog #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1112,9 +1112,9 @@ ProviderCondition.getInstance #### Defined in -[src/keeper/contracts/conditions/AccessCondition.ts:17](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/AccessCondition.ts#L17) +[src/keeper/contracts/conditions/AccessCondition.ts:17](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/AccessCondition.ts#L17) ---- +___ ### setInstanceConfig @@ -1122,15 +1122,15 @@ ProviderCondition.getInstance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1143,4 +1143,4 @@ ProviderCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/AccessService.md b/docs/nevermined-sdk/api-reference/classes/AccessService.md index 14a1948656..471fddfbd4 100644 --- a/docs/nevermined-sdk/api-reference/classes/AccessService.md +++ b/docs/nevermined-sdk/api-reference/classes/AccessService.md @@ -53,10 +53,10 @@ #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | -| `normal` | [`AccessTemplate`](AccessTemplate.md) | +| `normal` | [`AccessTemplate`](AccessTemplate.md) | #### Returns @@ -68,7 +68,7 @@ #### Defined in -[src/nevermined/AccessService.ts:31](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L31) +[src/nevermined/AccessService.ts:31](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L31) ## Properties @@ -78,7 +78,7 @@ #### Defined in -[src/nevermined/AccessService.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L29) +[src/nevermined/AccessService.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L29) ## Accessors @@ -96,9 +96,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -114,9 +114,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -132,9 +132,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -150,9 +150,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -168,9 +168,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -186,9 +186,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -204,9 +204,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -222,9 +222,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -234,69 +234,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -304,9 +304,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -316,38 +316,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -355,7 +355,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -365,8 +365,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------- | :------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | #### Returns @@ -379,9 +379,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/AccessService.ts:60](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L60) +[src/nevermined/AccessService.ts:60](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L60) ---- +___ ### createService @@ -389,13 +389,13 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------------------ | :---------------------------------------------------------------------------- | -| `publisher` | [`NvmAccount`](NvmAccount.md) | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | -| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | -| `pricedData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | +| Name | Type | +| :------ | :------ | +| `publisher` | [`NvmAccount`](NvmAccount.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `pricedData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | #### Returns @@ -407,9 +407,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/AccessService.ts:37](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L37) +[src/nevermined/AccessService.ts:37](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L37) ---- +___ ### process @@ -417,11 +417,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :---------- | :------------------------------------------------------ | -| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -433,9 +433,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/AccessService.ts:53](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L53) +[src/nevermined/AccessService.ts:53](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L53) ---- +___ ### setInstanceConfig @@ -443,8 +443,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -457,9 +457,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### track @@ -467,11 +467,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :---------- | :------------------------------------------------------ | -| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -483,9 +483,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/AccessService.ts:63](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L63) +[src/nevermined/AccessService.ts:63](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L63) ---- +___ ### getInstance @@ -493,8 +493,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -507,9 +507,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -517,15 +517,15 @@ Instantiable.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -538,4 +538,4 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/AccessTemplate.md b/docs/nevermined-sdk/api-reference/classes/AccessTemplate.md index e8c76f4e9d..16a9638190 100644 --- a/docs/nevermined-sdk/api-reference/classes/AccessTemplate.md +++ b/docs/nevermined-sdk/api-reference/classes/AccessTemplate.md @@ -91,8 +91,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -105,7 +105,7 @@ #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) ## Properties @@ -119,9 +119,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -133,9 +133,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -147,9 +147,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -161,9 +161,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -175,7 +175,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -193,9 +193,9 @@ BaseTemplate.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -211,9 +211,9 @@ BaseTemplate.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -229,9 +229,9 @@ BaseTemplate.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -247,9 +247,9 @@ BaseTemplate.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -265,9 +265,9 @@ BaseTemplate.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -283,9 +283,9 @@ BaseTemplate.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -301,9 +301,9 @@ BaseTemplate.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -319,9 +319,9 @@ BaseTemplate.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -331,69 +331,69 @@ BaseTemplate.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -401,9 +401,9 @@ BaseTemplate.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -413,38 +413,38 @@ BaseTemplate.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -452,7 +452,7 @@ BaseTemplate.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -462,8 +462,8 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :------- | :------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | #### Returns @@ -476,9 +476,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AccessTemplate.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AccessTemplate.ts#L127) +[src/keeper/contracts/templates/AccessTemplate.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AccessTemplate.ts#L127) ---- +___ ### agreementId @@ -486,10 +486,10 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `agreementIdSeed` | `string` | -| `creator` | `string` | +| `creator` | `string` | #### Returns @@ -501,9 +501,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L202) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L202) ---- +___ ### call @@ -512,16 +512,16 @@ BaseTemplate.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -533,9 +533,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### conditions @@ -551,9 +551,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AccessTemplate.ts:81](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AccessTemplate.ts#L81) +[src/keeper/contracts/templates/AccessTemplate.ts:81](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AccessTemplate.ts#L81) ---- +___ ### createAgreement @@ -561,16 +561,16 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `extraArgs` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `extraArgs` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -582,9 +582,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L73) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L73) ---- +___ ### createAgreementAndPay @@ -592,21 +592,21 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :--------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `accessConsumer` | `string` | -| `condIdx` | `number` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `bigint`[] | -| `receivers` | `string`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `accessConsumer` | `string` | +| `condIdx` | `number` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -618,9 +618,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L98) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L98) ---- +___ ### createAgreementFromDDO @@ -630,14 +630,14 @@ Create a new agreement using the data of a DDO. #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :---------- | -| `agreementIdSeed` | `string` | - | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `parameters` | `AccessTemplateParams` | | -| `consumer` | [`NvmAccount`](NvmAccount.md) | - | -| `timeOuts?` | `number`[] | - | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementIdSeed` | `string` | - | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `parameters` | `AccessTemplateParams` | | +| `consumer` | [`NvmAccount`](NvmAccount.md) | - | +| `timeOuts?` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | #### Returns @@ -651,9 +651,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L211) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L211) ---- +___ ### createAgreementWithPaymentFromDDO @@ -661,16 +661,16 @@ true if the call was successful. #### Parameters -| Name | Type | -| :----------------- | :------------------------------------------------------------------------------------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | -| `parameters` | `AccessTemplateParams` | -| `consumer` | [`NvmAccount`](NvmAccount.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | -| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | +| Name | Type | +| :------ | :------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `AccessTemplateParams` | +| `consumer` | [`NvmAccount`](NvmAccount.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | #### Returns @@ -682,9 +682,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L240) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L240) ---- +___ ### createService @@ -692,13 +692,13 @@ true if the call was successful. #### Parameters -| Name | Type | -| :------------------ | :---------------------------------------------------------------------------- | -| `publisher` | [`NvmAccount`](NvmAccount.md) | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | -| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | -| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | +| Name | Type | +| :------ | :------ | +| `publisher` | [`NvmAccount`](NvmAccount.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | #### Returns @@ -710,9 +710,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L48) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L48) ---- +___ ### description @@ -728,9 +728,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AccessTemplate.ts:37](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AccessTemplate.ts#L37) +[src/keeper/contracts/templates/AccessTemplate.ts:37](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AccessTemplate.ts#L37) ---- +___ ### extraGen @@ -738,8 +738,8 @@ true if the call was successful. #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | #### Returns @@ -752,9 +752,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) ---- +___ ### getAgreementCreatedEvent @@ -764,8 +764,8 @@ Generates and returns the agreement creation event. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns @@ -780,23 +780,23 @@ Agreement created event. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L450) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L450) ---- +___ ### getAgreementData -▸ **getAgreementData**(`agreementId`): `Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> +▸ **getAgreementData**(`agreementId`): `Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns -`Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> +`Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> #### Inherited from @@ -804,9 +804,9 @@ Agreement created event. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L29) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L29) ---- +___ ### getAgreementIdsFromDDO @@ -816,12 +816,12 @@ Get agreement conditions IDs. #### Parameters -| Name | Type | Description | -| :------------ | :--------------------- | :------------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `AccessTemplateParams` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | Agreement ID. | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `creator` | `string` | - | +| `params` | `AccessTemplateParams` | - | #### Returns @@ -835,25 +835,25 @@ The condition IDs. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L169) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L169) ---- +___ ### getAgreementStatus -▸ **getAgreementStatus**(`agreementId`): `Promise`\<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> +▸ **getAgreementStatus**(`agreementId`): `Promise`\<``false`` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> Returns the status of the conditions. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns -`Promise`\<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> +`Promise`\<``false`` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> The conditions status. @@ -863,9 +863,9 @@ The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L331) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L331) ---- +___ ### getAgreementsForDID @@ -873,8 +873,8 @@ The conditions status. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -887,9 +887,9 @@ The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L476) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L476) ---- +___ ### getConditionTypes @@ -909,9 +909,9 @@ A list of condition addresses. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L137) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L137) ---- +___ ### getConditions @@ -931,9 +931,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L148) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L148) ---- +___ ### getFromAddress @@ -941,8 +941,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -955,9 +955,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getServiceAgreementTemplate @@ -967,16 +967,16 @@ A list of condition contracts. `Object` -| Name | Type | -| :---------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `conditionDependency` | \{ `access`: `never`[] = []; `escrowPayment`: `string`[] ; `lockPayment`: `never`[] = [] } | -| `conditionDependency.access` | `never`[] | -| `conditionDependency.escrowPayment` | `string`[] | -| `conditionDependency.lockPayment` | `never`[] | -| `conditions` | \{ `contractName`: `string` = 'LockPaymentCondition'; `events`: \{ `actorType`: `string` = 'publisher'; `handler`: \{ `functionName`: `string` = 'fulfillAccessCondition'; `moduleName`: `string` = 'lockPaymentCondition'; `version`: `string` = '0.1' } ; `name`: `string` = 'Fulfilled' }[] ; `functionName`: `string` = 'fulfill'; `name`: `string` = 'lockPayment'; `parameters`: (\{ `name`: `string` = '\_did'; `type`: `string` = 'bytes32'; `value`: `string` = '' } \| \{ `name`: `string` = '\_amounts'; `type`: `string` = 'uint256[]'; `value`: `never`[] = [] })[] ; `timelock`: `number` = 0; `timeout`: `number` = 0 }[] | -| `contractName` | `string` | -| `events` | \{ `actorType`: `string` = 'consumer'; `handler`: \{ `functionName`: `string` = 'fulfillLockPaymentCondition'; `moduleName`: `string` = 'escrowAccessTemplate'; `version`: `string` = '0.1' } ; `name`: `string` = 'AgreementCreated' }[] | -| `fulfillmentOrder` | `string`[] | +| Name | Type | +| :------ | :------ | +| `conditionDependency` | \{ `access`: `never`[] = []; `escrowPayment`: `string`[] ; `lockPayment`: `never`[] = [] } | +| `conditionDependency.access` | `never`[] | +| `conditionDependency.escrowPayment` | `string`[] | +| `conditionDependency.lockPayment` | `never`[] | +| `conditions` | \{ `contractName`: `string` = 'LockPaymentCondition'; `events`: \{ `actorType`: `string` = 'publisher'; `handler`: \{ `functionName`: `string` = 'fulfillAccessCondition'; `moduleName`: `string` = 'lockPaymentCondition'; `version`: `string` = '0.1' } ; `name`: `string` = 'Fulfilled' }[] ; `functionName`: `string` = 'fulfill'; `name`: `string` = 'lockPayment'; `parameters`: (\{ `name`: `string` = '\_did'; `type`: `string` = 'bytes32'; `value`: `string` = '' } \| \{ `name`: `string` = '\_amounts'; `type`: `string` = 'uint256[]'; `value`: `never`[] = [] })[] ; `timelock`: `number` = 0; `timeout`: `number` = 0 }[] | +| `contractName` | `string` | +| `events` | \{ `actorType`: `string` = 'consumer'; `handler`: \{ `functionName`: `string` = 'fulfillLockPaymentCondition'; `moduleName`: `string` = 'escrowAccessTemplate'; `version`: `string` = '0.1' } ; `name`: `string` = 'AgreementCreated' }[] | +| `fulfillmentOrder` | `string`[] | #### Overrides @@ -984,9 +984,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AccessTemplate.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AccessTemplate.ts#L48) +[src/keeper/contracts/templates/AccessTemplate.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AccessTemplate.ts#L48) ---- +___ ### getServiceAgreementTemplateConditionByRef @@ -994,8 +994,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `ref` | `string` | #### Returns @@ -1008,9 +1008,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L314) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L314) ---- +___ ### getServiceAgreementTemplateConditions @@ -1026,17 +1026,17 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L309) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L309) ---- +___ ### getServiceAgreementTemplateDependencies -▸ **getServiceAgreementTemplateDependencies**(): `Promise`\<\{ `[condition: string]`: `string`[]; }\> +▸ **getServiceAgreementTemplateDependencies**(): `Promise`\<\{ `[condition: string]`: `string`[]; }\> #### Returns -`Promise`\<\{ `[condition: string]`: `string`[]; }\> +`Promise`\<\{ `[condition: string]`: `string`[]; }\> #### Inherited from @@ -1044,24 +1044,24 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L321) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L321) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -1069,9 +1069,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -1079,11 +1079,11 @@ A list of condition contracts. #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -1095,9 +1095,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instanceFromDDO @@ -1105,12 +1105,12 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :---------------- | :--------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `AccessTemplateParams` | +| Name | Type | +| :------ | :------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `parameters` | `AccessTemplateParams` | #### Returns @@ -1122,9 +1122,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AccessTemplate.ts:87](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AccessTemplate.ts#L87) +[src/keeper/contracts/templates/AccessTemplate.ts:87](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AccessTemplate.ts#L87) ---- +___ ### lockConditionIndex @@ -1140,9 +1140,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L57) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L57) ---- +___ ### lockTokens @@ -1150,12 +1150,12 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `tokenAddress` | `any` | +| `amounts` | `any` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1167,9 +1167,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L382) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L382) ---- +___ ### name @@ -1185,9 +1185,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AccessTemplate.ts:34](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AccessTemplate.ts#L34) +[src/keeper/contracts/templates/AccessTemplate.ts:34](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AccessTemplate.ts#L34) ---- +___ ### params @@ -1195,10 +1195,10 @@ A list of condition contracts. #### Parameters -| Name | Type | Default value | -| :------------ | :------------------------------------------------ | :------------ | -| `consumer` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | `'access'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `consumer` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | `'access'` | #### Returns @@ -1210,9 +1210,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AccessTemplate.ts:72](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AccessTemplate.ts#L72) +[src/keeper/contracts/templates/AccessTemplate.ts:72](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AccessTemplate.ts#L72) ---- +___ ### paramsGen @@ -1222,8 +1222,8 @@ Specialize params #### Parameters -| Name | Type | Description | -| :--------------- | :------------------------------------------------------ | :----------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `«destructured»` | [`ValidationParams`](../interfaces/ValidationParams.md) | Generic parameters | #### Returns @@ -1236,9 +1236,9 @@ Specialize params #### Defined in -[src/keeper/contracts/templates/AccessTemplate.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AccessTemplate.ts#L26) +[src/keeper/contracts/templates/AccessTemplate.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AccessTemplate.ts#L26) ---- +___ ### paymentData @@ -1246,8 +1246,8 @@ Specialize params #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | #### Returns @@ -1260,9 +1260,9 @@ Specialize params #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L61) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L61) ---- +___ ### printAgreementStatus @@ -1272,8 +1272,8 @@ Prints the agreement status. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns @@ -1286,9 +1286,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L418) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L418) ---- +___ ### process @@ -1296,11 +1296,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :---------- | :------------------------------------------------------ | -| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1312,9 +1312,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:126](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L126) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:126](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L126) ---- +___ ### send @@ -1322,12 +1322,12 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1339,9 +1339,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -1349,12 +1349,12 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1366,9 +1366,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### service @@ -1384,9 +1384,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AccessTemplate.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AccessTemplate.ts#L44) +[src/keeper/contracts/templates/AccessTemplate.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AccessTemplate.ts#L44) ---- +___ ### serviceEndpoint @@ -1402,9 +1402,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L44) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L44) ---- +___ ### setInstanceConfig @@ -1412,8 +1412,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1426,9 +1426,9 @@ Prints the agreement status. #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1436,8 +1436,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1450,9 +1450,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### standardContext @@ -1460,11 +1460,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :-------------- | :-------------- | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `serviceIndex?` | `number` | +| Name | Type | +| :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `serviceIndex?` | `number` | #### Returns @@ -1476,9 +1476,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L189) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L189) ---- +___ ### track @@ -1486,11 +1486,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :----------- | :------------------------------------------------------ | -| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `_from` | [`NvmAccount`](NvmAccount.md) | -| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `_from` | [`NvmAccount`](NvmAccount.md) | +| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1502,9 +1502,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:118](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L118) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:118](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L118) ---- +___ ### validateAgreement @@ -1512,14 +1512,14 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `AccessTemplateParams` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `extra` | `any` | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreement_id` | `string` | +| `did` | `string` | +| `params` | `AccessTemplateParams` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `extra` | `any` | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1531,9 +1531,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L141) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L141) ---- +___ ### getInstance @@ -1541,8 +1541,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1555,9 +1555,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AccessTemplate.ts:40](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AccessTemplate.ts#L40) +[src/keeper/contracts/templates/AccessTemplate.ts:40](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AccessTemplate.ts#L40) ---- +___ ### setInstanceConfig @@ -1565,15 +1565,15 @@ Prints the agreement status. #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1586,4 +1586,4 @@ Prints the agreement status. #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/Account.md b/docs/nevermined-sdk/api-reference/classes/Account.md deleted file mode 100644 index 4288aa2c53..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/Account.md +++ /dev/null @@ -1,700 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / Account - -# Class: Account - -Account information. - -## Hierarchy - -- `Instantiable` - - ↳ **`Account`** - -## Table of contents - -### Constructors - -- [constructor](Account.md#constructor) - -### Properties - -- [babySecret](Account.md#babysecret) -- [babyX](Account.md#babyx) -- [babyY](Account.md#babyy) -- [id](Account.md#id) -- [password](Account.md#password) -- [token](Account.md#token) - -### Accessors - -- [artifactsFolder](Account.md#artifactsfolder) -- [config](Account.md#config) -- [instanceConfig](Account.md#instanceconfig) -- [instantiableConfig](Account.md#instantiableconfig) -- [logger](Account.md#logger) -- [nevermined](Account.md#nevermined) -- [web3](Account.md#web3) - -### Methods - -- [addresses](Account.md#addresses) -- [authenticate](Account.md#authenticate) -- [checkExists](Account.md#checkexists) -- [findSigner](Account.md#findsigner) -- [getBalance](Account.md#getbalance) -- [getEtherBalance](Account.md#getetherbalance) -- [getId](Account.md#getid) -- [getNeverminedBalance](Account.md#getneverminedbalance) -- [getPassword](Account.md#getpassword) -- [getPublic](Account.md#getpublic) -- [getToken](Account.md#gettoken) -- [isTokenStored](Account.md#istokenstored) -- [requestTokens](Account.md#requesttokens) -- [setId](Account.md#setid) -- [setInstanceConfig](Account.md#setinstanceconfig) -- [setPassword](Account.md#setpassword) -- [setToken](Account.md#settoken) -- [addressesStatic](Account.md#addressesstatic) -- [findSignerStatic](Account.md#findsignerstatic) -- [getInstance](Account.md#getinstance) -- [setInstanceConfig](Account.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new Account**(`id?`, `config?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `id` | `string` | `'0x0'` | -| `config?` | `InstantiableConfig` | `undefined` | - -#### Overrides - -Instantiable.constructor - -#### Defined in - -[src/nevermined/Account.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L20) - -## Properties - -### babySecret - -• `Optional` **babySecret**: `string` - -#### Defined in - -[src/nevermined/Account.ts:18](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L18) - -___ - -### babyX - -• `Optional` **babyX**: `string` - -#### Defined in - -[src/nevermined/Account.ts:16](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L16) - -___ - -### babyY - -• `Optional` **babyY**: `string` - -#### Defined in - -[src/nevermined/Account.ts:17](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L17) - -___ - -### id - -• `Private` **id**: `string` = `'0x0'` - -#### Defined in - -[src/nevermined/Account.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L20) - -___ - -### password - -• `Private` `Optional` **password**: `string` - -#### Defined in - -[src/nevermined/Account.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L12) - -___ - -### token - -• `Private` `Optional` **token**: `string` - -#### Defined in - -[src/nevermined/Account.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L14) - -## Accessors - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -Instantiable.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -Instantiable.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Instantiable.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Instantiable.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -Instantiable.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -Instantiable.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -Instantiable.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addresses - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### authenticate - -▸ **authenticate**(): `Promise`<`void`\> - -Authenticate the account. - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[src/nevermined/Account.ts:82](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L82) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -Instantiable.checkExists - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSigner - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### getBalance - -▸ **getBalance**(): `Promise`<`default`\> - -Balances of Ether and Nevermined Token. - -#### Returns - -`Promise`<`default`\> - -#### Defined in - -[src/nevermined/Account.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L108) - -___ - -### getEtherBalance - -▸ **getEtherBalance**(): `Promise`<`default`\> - -Balance of Ether. - -#### Returns - -`Promise`<`default`\> - -#### Defined in - -[src/nevermined/Account.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L100) - -___ - -### getId - -▸ **getId**(): `string` - -#### Returns - -`string` - -#### Defined in - -[src/nevermined/Account.ts:27](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L27) - -___ - -### getNeverminedBalance - -▸ **getNeverminedBalance**(): `Promise`<`default`\> - -Balance of Nevermined Token. - -#### Returns - -`Promise`<`default`\> - -#### Defined in - -[src/nevermined/Account.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L90) - -___ - -### getPassword - -▸ **getPassword**(): `string` - -Returns account password. - -#### Returns - -`string` - -The account password. - -#### Defined in - -[src/nevermined/Account.ts:51](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L51) - -___ - -### getPublic - -▸ **getPublic**(): `string` - -#### Returns - -`string` - -#### Defined in - -[src/nevermined/Account.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L35) - -___ - -### getToken - -▸ **getToken**(): `Promise`<`string`\> - -Returns account token. - -#### Returns - -`Promise`<`string`\> - -Account token. - -#### Defined in - -[src/nevermined/Account.ts:67](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L67) - -___ - -### isTokenStored - -▸ **isTokenStored**(): `Promise`<`boolean`\> - -Returns if account token is stored. - -#### Returns - -`Promise`<`boolean`\> - -true if the token is stored. - -#### Defined in - -[src/nevermined/Account.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L75) - -___ - -### requestTokens - -▸ **requestTokens**(`amount`, `params?`): `Promise`<`string`\> - -Request Nevermined Tokens. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | `string` \| `number` \| `default` | Tokens to be requested. | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/nevermined/Account.ts:120](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L120) - -___ - -### setId - -▸ **setId**(`id`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `any` | - -#### Returns - -`void` - -#### Defined in - -[src/nevermined/Account.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L31) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -Instantiable.setInstanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### setPassword - -▸ **setPassword**(`password`): `void` - -Set account password. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `password` | `string` | Password for account. | - -#### Returns - -`void` - -#### Defined in - -[src/nevermined/Account.ts:43](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L43) - -___ - -### setToken - -▸ **setToken**(`token`): `void` - -Set account token. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `token` | `string` | Token for account. | - -#### Returns - -`void` - -#### Defined in - -[src/nevermined/Account.ts:59](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Account.ts#L59) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addressesStatic - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSignerStatic - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(...`_args`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `..._args` | `any` | - -#### Returns - -`any` - -#### Inherited from - -Instantiable.getInstance - -#### Defined in - -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L158) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -Instantiable.setInstanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/Accounts.md b/docs/nevermined-sdk/api-reference/classes/Accounts.md deleted file mode 100644 index bb1e92e184..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/Accounts.md +++ /dev/null @@ -1,489 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / Accounts - -# Class: Accounts - -Account submodule of Nevermined. - -## Hierarchy - -- `Instantiable` - - ↳ **`Accounts`** - -## Table of contents - -### Constructors - -- [constructor](Accounts.md#constructor) - -### Accessors - -- [artifactsFolder](Accounts.md#artifactsfolder) -- [config](Accounts.md#config) -- [instanceConfig](Accounts.md#instanceconfig) -- [instantiableConfig](Accounts.md#instantiableconfig) -- [logger](Accounts.md#logger) -- [nevermined](Accounts.md#nevermined) -- [web3](Accounts.md#web3) - -### Methods - -- [addresses](Accounts.md#addresses) -- [balance](Accounts.md#balance) -- [checkExists](Accounts.md#checkexists) -- [findSigner](Accounts.md#findsigner) -- [list](Accounts.md#list) -- [requestEthFromFaucet](Accounts.md#requestethfromfaucet) -- [requestList](Accounts.md#requestlist) -- [requestTokens](Accounts.md#requesttokens) -- [setInstanceConfig](Accounts.md#setinstanceconfig) -- [addressesStatic](Accounts.md#addressesstatic) -- [findSignerStatic](Accounts.md#findsignerstatic) -- [getInstance](Accounts.md#getinstance) -- [setInstanceConfig](Accounts.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new Accounts**() - -#### Inherited from - -Instantiable.constructor - -## Accessors - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -Instantiable.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -Instantiable.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Instantiable.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Instantiable.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -Instantiable.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -Instantiable.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -Instantiable.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addresses - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### balance - -▸ **balance**(`account`): `Promise`<`default`\> - -Return account balance. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | [`Account`](Account.md) | Account instance. | - -#### Returns - -`Promise`<`default`\> - -Ether and Nevermined Token balance. - -#### Defined in - -[src/nevermined/Accounts.ts:47](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Accounts.ts#L47) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -Instantiable.checkExists - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSigner - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### list - -▸ **list**(): `Promise`<[`Account`](Account.md)[]\> - -Returns the list of accounts. - -#### Returns - -`Promise`<[`Account`](Account.md)[]\> - -The list of accounts. - -#### Defined in - -[src/nevermined/Accounts.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Accounts.ts#L26) - -___ - -### requestEthFromFaucet - -▸ **requestEthFromFaucet**(`address`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[src/nevermined/Accounts.ts:70](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Accounts.ts#L70) - -___ - -### requestList - -▸ **requestList**(): `Promise`<[`Account`](Account.md)[]\> - -Returns the list of accounts including the addresses not controlled by the node, -only can be used by providers like metamask, Status or Trustwallet but not by default -provider - -#### Returns - -`Promise`<[`Account`](Account.md)[]\> - -#### Defined in - -[src/nevermined/Accounts.ts:38](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Accounts.ts#L38) - -___ - -### requestTokens - -▸ **requestTokens**(`account`, `amount`, `params?`): `Promise`<`boolean`\> - -Request tokens for an account. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | [`Account`](Account.md) | Account instance. | -| `amount` | `number` | Token amount. | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`boolean`\> - -true if the call was successful. false otherwise. - -#### Defined in - -[src/nevermined/Accounts.ts:57](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Accounts.ts#L57) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -Instantiable.setInstanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addressesStatic - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSignerStatic - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`Accounts`](Accounts.md)\> - -Returns the instance of Accounts. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`Accounts`](Accounts.md)\> - -[Accounts](Accounts.md) - -#### Overrides - -Instantiable.getInstance - -#### Defined in - -[src/nevermined/Accounts.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Accounts.ts#L14) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -Instantiable.setInstanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/AccountsApi.md b/docs/nevermined-sdk/api-reference/classes/AccountsApi.md index ba761ec038..01d0da3ab6 100644 --- a/docs/nevermined-sdk/api-reference/classes/AccountsApi.md +++ b/docs/nevermined-sdk/api-reference/classes/AccountsApi.md @@ -57,8 +57,8 @@ Creates a new AccountsApi #### Parameters -| Name | Type | Description | -| :------- | :---------------------------------------------------------- | :--------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Configuration of the Nevermined instance | #### Returns @@ -73,7 +73,7 @@ Creates a new AccountsApi #### Defined in -[src/nevermined/api/AccountsApi.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AccountsApi.ts#L16) +[src/nevermined/api/AccountsApi.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AccountsApi.ts#L16) ## Accessors @@ -91,9 +91,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -109,9 +109,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -127,9 +127,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -145,9 +145,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -163,9 +163,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -181,9 +181,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -199,9 +199,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -217,9 +217,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -229,69 +229,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -299,9 +299,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -311,38 +311,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -350,7 +350,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -368,9 +368,9 @@ The list of addresses. #### Defined in -[src/nevermined/api/AccountsApi.ts:70](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AccountsApi.ts#L70) +[src/nevermined/api/AccountsApi.ts:70](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AccountsApi.ts#L70) ---- +___ ### findAccount @@ -380,8 +380,8 @@ Given an address, it returns the account if it exists in the list of accounts. #### Parameters -| Name | Type | -| :----- | :------- | +| Name | Type | +| :------ | :------ | | `from` | `string` | #### Returns @@ -390,9 +390,9 @@ Given an address, it returns the account if it exists in the list of accounts. #### Defined in -[src/nevermined/api/AccountsApi.ts:56](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AccountsApi.ts#L56) +[src/nevermined/api/AccountsApi.ts:56](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AccountsApi.ts#L56) ---- +___ ### getAccount @@ -402,8 +402,8 @@ Returns an account initialized with existing web3 provider #### Parameters -| Name | Type | Description | -| :-------- | :------- | :------------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `address` | `string` | The account address | #### Returns @@ -414,9 +414,9 @@ The account #### Defined in -[src/nevermined/api/AccountsApi.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AccountsApi.ts#L47) +[src/nevermined/api/AccountsApi.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AccountsApi.ts#L47) ---- +___ ### getBalance @@ -426,8 +426,8 @@ It gets the balance of the native token (i.e ETH) and the ERC20 token associated #### Parameters -| Name | Type | Description | -| :-------- | :---------------------------------------- | :---------------------------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `account` | `string` \| [`NvmAccount`](NvmAccount.md) | Account instance or the address of the account to get the balance | #### Returns @@ -438,9 +438,9 @@ The balance of the ERC20 and Native tokens #### Defined in -[src/nevermined/api/AccountsApi.ts:188](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AccountsApi.ts#L188) +[src/nevermined/api/AccountsApi.ts:188](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AccountsApi.ts#L188) ---- +___ ### getEtherBalance @@ -450,8 +450,8 @@ It gets the native token (i.e ETH) balance of an account #### Parameters -| Name | Type | Description | -| :-------- | :---------------------------------------- | :---------------------------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `account` | `string` \| [`NvmAccount`](NvmAccount.md) | Account instance or the address of the account to get the balance | #### Returns @@ -462,9 +462,9 @@ the balance of the native token #### Defined in -[src/nevermined/api/AccountsApi.ts:177](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AccountsApi.ts#L177) +[src/nevermined/api/AccountsApi.ts:177](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AccountsApi.ts#L177) ---- +___ ### getNeverminedBalance @@ -474,8 +474,8 @@ It gets the balance of the ERC20 Token loaded in the Nevermined instance #### Parameters -| Name | Type | Description | -| :-------- | :---------------------------------------- | :---------------------------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `account` | `string` \| [`NvmAccount`](NvmAccount.md) | Account instance or the address of the account to get the balance | #### Returns @@ -486,9 +486,9 @@ the balance of ERC20 Token related to the account #### Defined in -[src/nevermined/api/AccountsApi.ts:164](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AccountsApi.ts#L164) +[src/nevermined/api/AccountsApi.ts:164](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AccountsApi.ts#L164) ---- +___ ### list @@ -504,9 +504,9 @@ The list of accounts. #### Defined in -[src/nevermined/api/AccountsApi.ts:25](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AccountsApi.ts#L25) +[src/nevermined/api/AccountsApi.ts:25](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AccountsApi.ts#L25) ---- +___ ### listBrowserAccounts @@ -524,9 +524,9 @@ The list of accounts. #### Defined in -[src/nevermined/api/AccountsApi.ts:35](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AccountsApi.ts#L35) +[src/nevermined/api/AccountsApi.ts:35](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AccountsApi.ts#L35) ---- +___ ### requestTokens @@ -536,11 +536,11 @@ Request tokens for an account. #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :------------------------------------------------------------------- | -| `account` | `string` \| [`NvmAccount`](NvmAccount.md) | Account instance or the address of the account to receive the tokens | -| `amount` | `bigint` | Token amount to request | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `string` \| [`NvmAccount`](NvmAccount.md) | Account instance or the address of the account to receive the tokens | +| `amount` | `bigint` | Token amount to request | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -550,9 +550,9 @@ true if the call was successful. false otherwise. #### Defined in -[src/nevermined/api/AccountsApi.ts:138](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AccountsApi.ts#L138) +[src/nevermined/api/AccountsApi.ts:138](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AccountsApi.ts#L138) ---- +___ ### setInstanceConfig @@ -560,8 +560,8 @@ true if the call was successful. false otherwise. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -574,9 +574,9 @@ true if the call was successful. false otherwise. #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### signTextWithRemoteAccount @@ -586,10 +586,10 @@ It signs a message using a remote account #### Parameters -| Name | Type | Description | -| :----- | :----------------------- | :--------------------------------------------------------- | -| `text` | `string` \| `Uint8Array` | the message to sign | -| `from` | `string` | the address of the remote account used to sign the message | +| Name | Type | Description | +| :------ | :------ | :------ | +| `text` | `string` \| `Uint8Array` | the message to sign | +| `from` | `string` | the address of the remote account used to sign the message | #### Returns @@ -599,9 +599,9 @@ the message signed message #### Defined in -[src/nevermined/api/AccountsApi.ts:80](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AccountsApi.ts#L80) +[src/nevermined/api/AccountsApi.ts:80](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AccountsApi.ts#L80) ---- +___ ### signTransactionWithRemoteAccount @@ -611,10 +611,10 @@ It signs a transaction using a remote account #### Parameters -| Name | Type | Description | -| :----- | :--------------- | :------------------------------------------------------------- | -| `data` | \`0x$\{string}\` | the transaction data | -| `from` | `string` | the address of the remote account used to sign the transaction | +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | \`0x$\{string}\` | the transaction data | +| `from` | `string` | the address of the remote account used to sign the transaction | #### Returns @@ -624,9 +624,9 @@ the signed transaction #### Defined in -[src/nevermined/api/AccountsApi.ts:97](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AccountsApi.ts#L97) +[src/nevermined/api/AccountsApi.ts:97](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AccountsApi.ts#L97) ---- +___ ### signTypedData @@ -636,12 +636,12 @@ It signs a typed data using a remote account #### Parameters -| Name | Type | Description | -| :------- | :---------------------------------------------------- | :------------------------------------------------------------ | -| `domain` | [`TypedDataDomain`](../interfaces/TypedDataDomain.md) | the domain of the typed data | -| `types` | [`TypedDataTypes`](../interfaces/TypedDataTypes.md) | the types of the typed data | -| `value` | `Record`\<`string`, `any`\> | the value of the typed data | -| `from` | `string` | the address of the remote account used to sign the typed data | +| Name | Type | Description | +| :------ | :------ | :------ | +| `domain` | [`TypedDataDomain`](../interfaces/TypedDataDomain.md) | the domain of the typed data | +| `types` | [`TypedDataTypes`](../interfaces/TypedDataTypes.md) | the types of the typed data | +| `value` | `Record`\<`string`, `any`\> | the value of the typed data | +| `from` | `string` | the address of the remote account used to sign the typed data | #### Returns @@ -651,9 +651,9 @@ the signed typed data #### Defined in -[src/nevermined/api/AccountsApi.ts:116](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AccountsApi.ts#L116) +[src/nevermined/api/AccountsApi.ts:116](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AccountsApi.ts#L116) ---- +___ ### getInstance @@ -661,8 +661,8 @@ the signed typed data #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -675,9 +675,9 @@ the signed typed data #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -685,15 +685,15 @@ the signed typed data #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -706,4 +706,4 @@ the signed typed data #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/AgreementStoreManager.md b/docs/nevermined-sdk/api-reference/classes/AgreementStoreManager.md index 75eff2b821..9ed6420892 100644 --- a/docs/nevermined-sdk/api-reference/classes/AgreementStoreManager.md +++ b/docs/nevermined-sdk/api-reference/classes/AgreementStoreManager.md @@ -64,8 +64,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -78,7 +78,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -92,9 +92,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -106,9 +106,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -120,9 +120,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -134,9 +134,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### templates @@ -144,9 +144,9 @@ #### Defined in -[src/keeper/contracts/managers/AgreementStoreManager.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/AgreementStoreManager.ts#L21) +[src/keeper/contracts/managers/AgreementStoreManager.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/AgreementStoreManager.ts#L21) ---- +___ ### version @@ -158,7 +158,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -176,9 +176,9 @@ ContractBase.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -194,9 +194,9 @@ ContractBase.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -212,9 +212,9 @@ ContractBase.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -230,9 +230,9 @@ ContractBase.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -248,9 +248,9 @@ ContractBase.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -266,9 +266,9 @@ ContractBase.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -284,9 +284,9 @@ ContractBase.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -302,9 +302,9 @@ ContractBase.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -314,69 +314,69 @@ ContractBase.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -384,9 +384,9 @@ ContractBase.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -396,38 +396,38 @@ ContractBase.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -435,7 +435,7 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -445,10 +445,10 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :----- | :------- | +| Name | Type | +| :------ | :------ | | `name` | `string` | -| `obj` | `any` | +| `obj` | `any` | #### Returns @@ -456,9 +456,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/AgreementStoreManager.ts:35](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/AgreementStoreManager.ts#L35) +[src/keeper/contracts/managers/AgreementStoreManager.ts:35](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/AgreementStoreManager.ts#L35) ---- +___ ### agreementId @@ -466,10 +466,10 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `agreementIdSeed` | `string` | -| `creator` | `string` | +| `creator` | `string` | #### Returns @@ -477,9 +477,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/AgreementStoreManager.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/AgreementStoreManager.ts#L100) +[src/keeper/contracts/managers/AgreementStoreManager.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/AgreementStoreManager.ts#L100) ---- +___ ### call @@ -488,16 +488,16 @@ ContractBase.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -509,9 +509,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### createAgreement @@ -519,16 +519,16 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :--------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionTypes` | `string`[] | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionTypes` | `string`[] | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -536,9 +536,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/AgreementStoreManager.ts:104](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/AgreementStoreManager.ts#L104) +[src/keeper/contracts/managers/AgreementStoreManager.ts:104](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/AgreementStoreManager.ts#L104) ---- +___ ### getAgreement @@ -546,10 +546,10 @@ ContractBase.walletClient #### Parameters -| Name | Type | Default value | -| :------------ | :-------- | :------------ | -| `agreementId` | `string` | `undefined` | -| `tryOnchain` | `boolean` | `false` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | +| `tryOnchain` | `boolean` | `false` | #### Returns @@ -557,9 +557,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/AgreementStoreManager.ts:43](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/AgreementStoreManager.ts#L43) +[src/keeper/contracts/managers/AgreementStoreManager.ts:43](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/AgreementStoreManager.ts#L43) ---- +___ ### getAgreements @@ -567,8 +567,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -577,9 +577,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/AgreementStoreManager.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/AgreementStoreManager.ts#L92) +[src/keeper/contracts/managers/AgreementStoreManager.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/AgreementStoreManager.ts#L92) ---- +___ ### getFromAddress @@ -587,8 +587,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -601,9 +601,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getOwner @@ -615,24 +615,24 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/AgreementStoreManager.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/AgreementStoreManager.ts#L39) +[src/keeper/contracts/managers/AgreementStoreManager.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/AgreementStoreManager.ts#L39) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -640,9 +640,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -650,11 +650,11 @@ ContractBase.walletClient #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -666,9 +666,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### send @@ -676,12 +676,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -693,9 +693,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -703,12 +703,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -720,9 +720,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -730,8 +730,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -744,9 +744,9 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### setTemplates @@ -754,8 +754,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :----- | :---- | +| Name | Type | +| :------ | :------ | | `temp` | `any` | #### Returns @@ -764,9 +764,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/AgreementStoreManager.ts:31](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/AgreementStoreManager.ts#L31) +[src/keeper/contracts/managers/AgreementStoreManager.ts:31](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/AgreementStoreManager.ts#L31) ---- +___ ### someLog @@ -774,8 +774,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -788,9 +788,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -798,8 +798,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -812,9 +812,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/AgreementStoreManager.ts:23](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/AgreementStoreManager.ts#L23) +[src/keeper/contracts/managers/AgreementStoreManager.ts:23](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/AgreementStoreManager.ts#L23) ---- +___ ### setInstanceConfig @@ -822,15 +822,15 @@ ContractBase.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -843,4 +843,4 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/AgreementTemplate.md b/docs/nevermined-sdk/api-reference/classes/AgreementTemplate.md index 2d520493d4..cf024c9e4c 100644 --- a/docs/nevermined-sdk/api-reference/classes/AgreementTemplate.md +++ b/docs/nevermined-sdk/api-reference/classes/AgreementTemplate.md @@ -4,8 +4,8 @@ ## Type parameters -| Name | -| :------- | +| Name | +| :------ | | `Params` | ## Hierarchy @@ -89,14 +89,14 @@ #### Type parameters -| Name | -| :------- | +| Name | +| :------ | | `Params` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -109,7 +109,7 @@ #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) ## Properties @@ -119,9 +119,9 @@ #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L35) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L35) ---- +___ ### \_conditions @@ -129,9 +129,9 @@ #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:36](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L36) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:36](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L36) ---- +___ ### address @@ -143,9 +143,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -157,9 +157,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -171,9 +171,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -185,9 +185,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -199,7 +199,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -217,9 +217,9 @@ ContractBase.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -235,9 +235,9 @@ ContractBase.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -253,9 +253,9 @@ ContractBase.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -271,9 +271,9 @@ ContractBase.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -289,9 +289,9 @@ ContractBase.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -307,9 +307,9 @@ ContractBase.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -325,9 +325,9 @@ ContractBase.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -343,9 +343,9 @@ ContractBase.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -355,69 +355,69 @@ ContractBase.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -425,9 +425,9 @@ ContractBase.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -437,38 +437,38 @@ ContractBase.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -476,7 +476,7 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -486,10 +486,10 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `agreementIdSeed` | `string` | -| `creator` | `string` | +| `creator` | `string` | #### Returns @@ -497,9 +497,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L202) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L202) ---- +___ ### call @@ -508,16 +508,16 @@ ContractBase.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -529,9 +529,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### createAgreement @@ -539,16 +539,16 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `extraArgs` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `extraArgs` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -556,9 +556,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L73) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L73) ---- +___ ### createAgreementAndPay @@ -566,21 +566,21 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :--------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `accessConsumer` | `string` | -| `condIdx` | `number` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `bigint`[] | -| `receivers` | `string`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `accessConsumer` | `string` | +| `condIdx` | `number` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -588,9 +588,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L98) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L98) ---- +___ ### createAgreementFromDDO @@ -600,14 +600,14 @@ Create a new agreement using the data of a DDO. #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :---------- | -| `agreementIdSeed` | `string` | - | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `parameters` | `Params` | | -| `consumer` | [`NvmAccount`](NvmAccount.md) | - | -| `timeOuts?` | `number`[] | - | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementIdSeed` | `string` | - | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `parameters` | `Params` | | +| `consumer` | [`NvmAccount`](NvmAccount.md) | - | +| `timeOuts?` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | #### Returns @@ -617,9 +617,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L211) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L211) ---- +___ ### createAgreementWithPaymentFromDDO @@ -627,16 +627,16 @@ true if the call was successful. #### Parameters -| Name | Type | -| :----------------- | :------------------------------------------------------------------------------------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | -| `parameters` | `Params` | -| `consumer` | [`NvmAccount`](NvmAccount.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | -| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | +| Name | Type | +| :------ | :------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `Params` | +| `consumer` | [`NvmAccount`](NvmAccount.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | #### Returns @@ -644,9 +644,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L240) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L240) ---- +___ ### getAgreementCreatedEvent @@ -656,8 +656,8 @@ Generates and returns the agreement creation event. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns @@ -668,9 +668,9 @@ Agreement created event. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L450) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L450) ---- +___ ### getAgreementIdsFromDDO @@ -680,12 +680,12 @@ Get agreement conditions IDs. #### Parameters -| Name | Type | Description | -| :------------ | :-------------- | :------------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `Params` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | Agreement ID. | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `creator` | `string` | - | +| `params` | `Params` | - | #### Returns @@ -695,33 +695,33 @@ The condition IDs. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L169) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L169) ---- +___ ### getAgreementStatus -▸ **getAgreementStatus**(`agreementId`): `Promise`\<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> +▸ **getAgreementStatus**(`agreementId`): `Promise`\<``false`` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> Returns the status of the conditions. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns -`Promise`\<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> +`Promise`\<``false`` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L331) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L331) ---- +___ ### getAgreementsForDID @@ -729,8 +729,8 @@ The conditions status. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -739,9 +739,9 @@ The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L476) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L476) ---- +___ ### getConditionTypes @@ -757,9 +757,9 @@ A list of condition addresses. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L137) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L137) ---- +___ ### getConditions @@ -775,9 +775,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L148) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L148) ---- +___ ### getFromAddress @@ -785,8 +785,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -799,9 +799,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getServiceAgreementTemplate @@ -813,9 +813,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:307](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L307) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:307](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L307) ---- +___ ### getServiceAgreementTemplateConditionByRef @@ -823,8 +823,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `ref` | `string` | #### Returns @@ -833,9 +833,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L314) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L314) ---- +___ ### getServiceAgreementTemplateConditions @@ -847,38 +847,38 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L309) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L309) ---- +___ ### getServiceAgreementTemplateDependencies -▸ **getServiceAgreementTemplateDependencies**(): `Promise`\<\{ `[condition: string]`: `string`[]; }\> +▸ **getServiceAgreementTemplateDependencies**(): `Promise`\<\{ `[condition: string]`: `string`[]; }\> #### Returns -`Promise`\<\{ `[condition: string]`: `string`[]; }\> +`Promise`\<\{ `[condition: string]`: `string`[]; }\> #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L321) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L321) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -886,9 +886,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -896,11 +896,11 @@ A list of condition contracts. #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -912,9 +912,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instanceFromDDO @@ -922,13 +922,13 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :---------------- | :-------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `Params` | -| `serviceIndex?` | `number` | +| Name | Type | +| :------ | :------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `parameters` | `Params` | +| `serviceIndex?` | `number` | #### Returns @@ -936,9 +936,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:179](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L179) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:179](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L179) ---- +___ ### lockConditionIndex @@ -950,9 +950,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L57) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L57) ---- +___ ### lockTokens @@ -960,12 +960,12 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `tokenAddress` | `any` | +| `amounts` | `any` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -973,9 +973,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L382) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L382) ---- +___ ### params @@ -983,8 +983,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -993,9 +993,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:55](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L55) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:55](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L55) ---- +___ ### paymentData @@ -1003,8 +1003,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | #### Returns @@ -1013,9 +1013,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L61) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L61) ---- +___ ### printAgreementStatus @@ -1025,8 +1025,8 @@ Prints the agreement status. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns @@ -1035,9 +1035,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L418) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L418) ---- +___ ### send @@ -1045,12 +1045,12 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1062,9 +1062,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -1072,12 +1072,12 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1089,9 +1089,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### service @@ -1103,9 +1103,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:187](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L187) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:187](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L187) ---- +___ ### setInstanceConfig @@ -1113,8 +1113,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1127,9 +1127,9 @@ Prints the agreement status. #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1137,8 +1137,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1151,9 +1151,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### standardContext @@ -1161,11 +1161,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :-------------- | :-------------- | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `serviceIndex?` | `number` | +| Name | Type | +| :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `serviceIndex?` | `number` | #### Returns @@ -1173,9 +1173,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L189) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L189) ---- +___ ### getInstance @@ -1183,18 +1183,18 @@ Prints the agreement status. #### Type parameters -| Name | -| :------- | +| Name | +| :------ | | `Params` | #### Parameters -| Name | Type | Default value | -| :--------------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `templateContractName` | `string` | `undefined` | -| `templateClass` | `any` | `undefined` | -| `optional` | `boolean` | `false` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `templateContractName` | `string` | `undefined` | +| `templateClass` | `any` | `undefined` | +| `optional` | `boolean` | `false` | #### Returns @@ -1206,9 +1206,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:38](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L38) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:38](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L38) ---- +___ ### setInstanceConfig @@ -1216,15 +1216,15 @@ Prints the agreement status. #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1237,4 +1237,4 @@ Prints the agreement status. #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/AgreementsApi.md b/docs/nevermined-sdk/api-reference/classes/AgreementsApi.md index 17834259f9..e701d4950d 100644 --- a/docs/nevermined-sdk/api-reference/classes/AgreementsApi.md +++ b/docs/nevermined-sdk/api-reference/classes/AgreementsApi.md @@ -55,8 +55,8 @@ Creates a new AgreementsApi #### Parameters -| Name | Type | Description | -| :------- | :---------------------------------------------------------- | :--------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Configuration of the Nevermined instance | #### Returns @@ -71,7 +71,7 @@ Creates a new AgreementsApi #### Defined in -[src/nevermined/api/AgreementsApi.ts:28](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AgreementsApi.ts#L28) +[src/nevermined/api/AgreementsApi.ts:28](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AgreementsApi.ts#L28) ## Properties @@ -83,7 +83,7 @@ Agreements Conditions submodule. #### Defined in -[src/nevermined/api/AgreementsApi.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AgreementsApi.ts#L21) +[src/nevermined/api/AgreementsApi.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AgreementsApi.ts#L21) ## Accessors @@ -101,9 +101,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -119,9 +119,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -137,9 +137,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -155,9 +155,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -173,9 +173,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -191,9 +191,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -209,9 +209,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -227,9 +227,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -239,69 +239,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -309,9 +309,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -321,38 +321,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -360,7 +360,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -372,14 +372,14 @@ Create a service agreement on-chain. This should be called by the publisher of t #### Parameters -| Name | Type | Description | -| :---------------- | :------------------------------------------------ | :----------------------------------------------------- | -| `did` | `string` | Decentralized ID. | -| `agreementIdSeed` | `string` | Service agreement ID seed. | -| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | Service. | -| `agreementParams` | `any` | Agreement parameters. | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the user creating the service agreement | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | Decentralized ID. | +| `agreementIdSeed` | `string` | Service agreement ID seed. | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `agreementParams` | `any` | Agreement parameters. | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the user creating the service agreement | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters. | #### Returns @@ -394,9 +394,9 @@ in this method before submitting on-chain. #### Defined in -[src/nevermined/api/AgreementsApi.ts:88](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AgreementsApi.ts#L88) +[src/nevermined/api/AgreementsApi.ts:88](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AgreementsApi.ts#L88) ---- +___ ### getAgreement @@ -406,8 +406,8 @@ It returns the details of one agreement #### Parameters -| Name | Type | Description | -| :------------ | :------- | :---------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | The unique agreement id | #### Returns @@ -418,9 +418,9 @@ the details of the agreement #### Defined in -[src/nevermined/api/AgreementsApi.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AgreementsApi.ts#L140) +[src/nevermined/api/AgreementsApi.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AgreementsApi.ts#L140) ---- +___ ### getAgreements @@ -430,8 +430,8 @@ Gets the list of agreements created about an asset #### Parameters -| Name | Type | Description | -| :---- | :------- | :--------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `did` | `string` | the unique identifier of the asset | #### Returns @@ -442,9 +442,9 @@ the list of agreements #### Defined in -[src/nevermined/api/AgreementsApi.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AgreementsApi.ts#L149) +[src/nevermined/api/AgreementsApi.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AgreementsApi.ts#L149) ---- +___ ### isAccessGranted @@ -454,12 +454,12 @@ Checks if a consumer has permissions for a certain DID and Agreement Id #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------- | :--------------------------------- | -| `agreementId` | `string` | the agreement id | -| `did` | `string` | the unique identifier of the asset | -| `consumerAddress` | `string` | the address of the consumer | -| `from` | [`NvmAccount`](NvmAccount.md) | the user account | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | the agreement id | +| `did` | `string` | the unique identifier of the asset | +| `consumerAddress` | `string` | the address of the consumer | +| `from` | [`NvmAccount`](NvmAccount.md) | the user account | #### Returns @@ -469,9 +469,9 @@ true if the user has permissions #### Defined in -[src/nevermined/api/AgreementsApi.ts:161](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AgreementsApi.ts#L161) +[src/nevermined/api/AgreementsApi.ts:161](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AgreementsApi.ts#L161) ---- +___ ### prepareSignature @@ -481,11 +481,11 @@ Creates a consumer signature for the specified asset service. #### Parameters -| Name | Type | Description | -| :------------ | :------------------------------------------------ | :---------------- | -| `did` | `string` | Decentralized ID. | -| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | Service. | -| `from` | [`NvmAccount`](NvmAccount.md) | Consumer account. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | Decentralized ID. | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `from` | [`NvmAccount`](NvmAccount.md) | Consumer account. | #### Returns @@ -495,9 +495,9 @@ The agreement ID and signature. #### Defined in -[src/nevermined/api/AgreementsApi.ts:45](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AgreementsApi.ts#L45) +[src/nevermined/api/AgreementsApi.ts:45](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AgreementsApi.ts#L45) ---- +___ ### setInstanceConfig @@ -505,8 +505,8 @@ The agreement ID and signature. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -519,9 +519,9 @@ The agreement ID and signature. #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### status @@ -531,10 +531,10 @@ Get the status of a service agreement. #### Parameters -| Name | Type | Default value | Description | -| :------------ | :-------- | :------------ | :--------------------------------------------------- | -| `agreementId` | `string` | `undefined` | Service agreement ID. | -| `extended` | `boolean` | `false` | If true returns a complete status with dependencies. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | Service agreement ID. | +| `extended` | `boolean` | `false` | If true returns a complete status with dependencies. | #### Returns @@ -544,9 +544,9 @@ status of the agreement #### Defined in -[src/nevermined/api/AgreementsApi.ts:114](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AgreementsApi.ts#L114) +[src/nevermined/api/AgreementsApi.ts:114](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AgreementsApi.ts#L114) ---- +___ ### getInstance @@ -554,8 +554,8 @@ status of the agreement #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -568,9 +568,9 @@ status of the agreement #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -578,15 +578,15 @@ status of the agreement #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -599,4 +599,4 @@ status of the agreement #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/ApiError.md b/docs/nevermined-sdk/api-reference/classes/ApiError.md index eb35606724..837dc7ff9e 100644 --- a/docs/nevermined-sdk/api-reference/classes/ApiError.md +++ b/docs/nevermined-sdk/api-reference/classes/ApiError.md @@ -35,8 +35,8 @@ #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `message` | `string` | #### Returns @@ -49,7 +49,7 @@ Error.constructor #### Defined in -[src/errors/NeverminedErrors.ts:32](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/errors/NeverminedErrors.ts#L32) +[src/errors/NeverminedErrors.ts:32](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/errors/NeverminedErrors.ts#L32) ## Properties @@ -65,7 +65,7 @@ Error.cause node_modules/typescript/lib/lib.es2022.error.d.ts:24 ---- +___ ### message @@ -79,7 +79,7 @@ Error.message node_modules/typescript/lib/lib.es5.d.ts:1077 ---- +___ ### name @@ -93,7 +93,7 @@ Error.name node_modules/typescript/lib/lib.es5.d.ts:1076 ---- +___ ### stack @@ -107,7 +107,7 @@ Error.stack node_modules/typescript/lib/lib.es5.d.ts:1078 ---- +___ ### prepareStackTrace @@ -125,9 +125,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ##### Parameters -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | +| Name | Type | +| :------ | :------ | +| `err` | `Error` | | `stackTraces` | `CallSite`[] | ##### Returns @@ -142,7 +142,7 @@ Error.prepareStackTrace node_modules/@types/node/globals.d.ts:28 ---- +___ ### stackTraceLimit @@ -166,9 +166,9 @@ Create .stack property on a target object #### Parameters -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | | `constructorOpt?` | `Function` | #### Returns diff --git a/docs/nevermined-sdk/api-reference/classes/AssetAttributes.md b/docs/nevermined-sdk/api-reference/classes/AssetAttributes.md index 1866ad0d11..9e899c9254 100644 --- a/docs/nevermined-sdk/api-reference/classes/AssetAttributes.md +++ b/docs/nevermined-sdk/api-reference/classes/AssetAttributes.md @@ -51,9 +51,9 @@ That asset association typically helps to search and filter between assets part #### Defined in -[src/models/AssetAttributes.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L48) +[src/models/AssetAttributes.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L48) ---- +___ ### encryptionMethod @@ -68,9 +68,9 @@ This method allows to specify the encryption method to be used. #### Defined in -[src/models/AssetAttributes.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L21) +[src/models/AssetAttributes.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L21) ---- +___ ### fulfillAccessTimelock @@ -85,9 +85,9 @@ This would allow to create an agreement that can not fulfilled until certain per #### Defined in -[src/models/AssetAttributes.ts:68](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L68) +[src/models/AssetAttributes.ts:68](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L68) ---- +___ ### fulfillAccessTimeout @@ -102,9 +102,9 @@ This would allow to create an agreement that is not fulfilled after a certain pe #### Defined in -[src/models/AssetAttributes.ts:58](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L58) +[src/models/AssetAttributes.ts:58](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L58) ---- +___ ### metadata @@ -118,9 +118,9 @@ Metadata describing the asset #### Defined in -[src/models/AssetAttributes.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L14) +[src/models/AssetAttributes.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L14) ---- +___ ### predefinedAssetServices @@ -134,9 +134,9 @@ List of additional asset services to be included as part of an asset #### Defined in -[src/models/AssetAttributes.ts:33](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L33) +[src/models/AssetAttributes.ts:33](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L33) ---- +___ ### providers @@ -150,9 +150,9 @@ Typically just the address of one Nevermined Node trusted by the user. #### Defined in -[src/models/AssetAttributes.ts:42](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L42) +[src/models/AssetAttributes.ts:42](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L42) ---- +___ ### services @@ -166,9 +166,9 @@ List of services and their attributes offered by an asset. #### Defined in -[src/models/AssetAttributes.ts:27](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L27) +[src/models/AssetAttributes.ts:27](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L27) ---- +___ ### defaultValues @@ -176,19 +176,19 @@ List of services and their attributes offered by an asset. #### Type declaration -| Name | Type | -| :------------------------ | :--------------------------------------------------------------------------------------------------------------- | -| `appId` | `string` | -| `encryptionMethod` | [`EncryptionMethod`](../code-reference.md#encryptionmethod) | -| `fulfillAccessTimelock` | `number` | -| `fulfillAccessTimeout` | `number` | -| `predefinedAssetServices` | [`ServiceCommon`](../interfaces/ServiceCommon.md)[] | -| `providers` | `never`[] | -| `services` | \{ `price`: [`AssetPrice`](AssetPrice.md) ; `serviceType`: [`ServiceType`](../code-reference.md#servicetype) }[] | +| Name | Type | +| :------ | :------ | +| `appId` | `string` | +| `encryptionMethod` | [`EncryptionMethod`](../code-reference.md#encryptionmethod) | +| `fulfillAccessTimelock` | `number` | +| `fulfillAccessTimeout` | `number` | +| `predefinedAssetServices` | [`ServiceCommon`](../interfaces/ServiceCommon.md)[] | +| `providers` | `never`[] | +| `services` | \{ `price`: [`AssetPrice`](AssetPrice.md) ; `serviceType`: [`ServiceType`](../code-reference.md#servicetype) }[] | #### Defined in -[src/models/AssetAttributes.ts:70](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L70) +[src/models/AssetAttributes.ts:70](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L70) ## Methods @@ -198,8 +198,8 @@ List of services and their attributes offered by an asset. #### Parameters -| Name | Type | -| :---------------- | :-------------------------------------- | +| Name | Type | +| :------ | :------ | | `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | #### Returns @@ -208,4 +208,4 @@ List of services and their attributes offered by an asset. #### Defined in -[src/models/AssetAttributes.ts:85](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L85) +[src/models/AssetAttributes.ts:85](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L85) diff --git a/docs/nevermined-sdk/api-reference/classes/AssetError.md b/docs/nevermined-sdk/api-reference/classes/AssetError.md index 1b2e441900..e236f06cd6 100644 --- a/docs/nevermined-sdk/api-reference/classes/AssetError.md +++ b/docs/nevermined-sdk/api-reference/classes/AssetError.md @@ -35,8 +35,8 @@ #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `message` | `string` | #### Returns @@ -49,7 +49,7 @@ Error.constructor #### Defined in -[src/errors/NeverminedErrors.ts:56](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/errors/NeverminedErrors.ts#L56) +[src/errors/NeverminedErrors.ts:56](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/errors/NeverminedErrors.ts#L56) ## Properties @@ -65,7 +65,7 @@ Error.cause node_modules/typescript/lib/lib.es2022.error.d.ts:24 ---- +___ ### message @@ -79,7 +79,7 @@ Error.message node_modules/typescript/lib/lib.es5.d.ts:1077 ---- +___ ### name @@ -93,7 +93,7 @@ Error.name node_modules/typescript/lib/lib.es5.d.ts:1076 ---- +___ ### stack @@ -107,7 +107,7 @@ Error.stack node_modules/typescript/lib/lib.es5.d.ts:1078 ---- +___ ### prepareStackTrace @@ -125,9 +125,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ##### Parameters -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | +| Name | Type | +| :------ | :------ | +| `err` | `Error` | | `stackTraces` | `CallSite`[] | ##### Returns @@ -142,7 +142,7 @@ Error.prepareStackTrace node_modules/@types/node/globals.d.ts:28 ---- +___ ### stackTraceLimit @@ -166,9 +166,9 @@ Create .stack property on a target object #### Parameters -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | | `constructorOpt?` | `Function` | #### Returns diff --git a/docs/nevermined-sdk/api-reference/classes/AssetPrice.md b/docs/nevermined-sdk/api-reference/classes/AssetPrice.md index 46600ecb6d..c5d0e58dac 100644 --- a/docs/nevermined-sdk/api-reference/classes/AssetPrice.md +++ b/docs/nevermined-sdk/api-reference/classes/AssetPrice.md @@ -42,14 +42,14 @@ #### Defined in -[src/models/AssetPrice.ts:10](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L10) +[src/models/AssetPrice.ts:10](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L10) • **new AssetPrice**(`_rewards`): [`AssetPrice`](AssetPrice.md) #### Parameters -| Name | Type | -| :--------- | :-------------------------- | +| Name | Type | +| :------ | :------ | | `_rewards` | `Map`\<`string`, `bigint`\> | #### Returns @@ -58,16 +58,16 @@ #### Defined in -[src/models/AssetPrice.ts:11](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L11) +[src/models/AssetPrice.ts:11](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L11) • **new AssetPrice**(`address`, `amount`): [`AssetPrice`](AssetPrice.md) #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `address` | `string` | -| `amount` | `bigint` | +| `amount` | `bigint` | #### Returns @@ -75,16 +75,16 @@ #### Defined in -[src/models/AssetPrice.ts:12](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L12) +[src/models/AssetPrice.ts:12](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L12) • **new AssetPrice**(`address`, `amount`, `tokenAddress`): [`AssetPrice`](AssetPrice.md) #### Parameters -| Name | Type | -| :------------- | :------- | -| `address` | `string` | -| `amount` | `bigint` | +| Name | Type | +| :------ | :------ | +| `address` | `string` | +| `amount` | `bigint` | | `tokenAddress` | `string` | #### Returns @@ -93,7 +93,7 @@ #### Defined in -[src/models/AssetPrice.ts:13](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L13) +[src/models/AssetPrice.ts:13](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L13) ## Properties @@ -103,9 +103,9 @@ #### Defined in -[src/models/AssetPrice.ts:6](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L6) +[src/models/AssetPrice.ts:6](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L6) ---- +___ ### tokenAddress @@ -113,9 +113,9 @@ #### Defined in -[src/models/AssetPrice.ts:8](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L8) +[src/models/AssetPrice.ts:8](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L8) ---- +___ ### totalPrice @@ -123,7 +123,7 @@ #### Defined in -[src/models/AssetPrice.ts:4](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L4) +[src/models/AssetPrice.ts:4](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L4) ## Methods @@ -135,9 +135,9 @@ It adds network fees on top of the already configured asset rewards #### Parameters -| Name | Type | Description | -| :------------------ | :------- | :--------------------------------------------------------------- | -| `feeReceiver` | `string` | the address receiving the fees | +| Name | Type | Description | +| :------ | :------ | :------ | +| `feeReceiver` | `string` | the address receiving the fees | | `networkFeePercent` | `bigint` | the percent of fees to receive, it uses the contract denominator | #### Returns @@ -152,9 +152,9 @@ AssetPrice.NETWORK_FEE_DENOMINATOR #### Defined in -[src/models/AssetPrice.ts:77](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L77) +[src/models/AssetPrice.ts:77](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L77) ---- +___ ### adjustToIncludeNetworkFees @@ -164,9 +164,9 @@ It includes network fees on the existing asset rewards subtracting the proportio #### Parameters -| Name | Type | Description | -| :------------------ | :------- | :--------------------------------------------------------------- | -| `feeReceiver` | `string` | the address receiving the fees | +| Name | Type | Description | +| :------ | :------ | :------ | +| `feeReceiver` | `string` | the address receiving the fees | | `networkFeePercent` | `bigint` | the percent of fees to receive, it uses the contract denominator | #### Returns @@ -181,9 +181,9 @@ AssetPrice.NETWORK_FEE_DENOMINATOR #### Defined in -[src/models/AssetPrice.ts:88](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L88) +[src/models/AssetPrice.ts:88](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L88) ---- +___ ### getAmounts @@ -195,9 +195,9 @@ AssetPrice.NETWORK_FEE_DENOMINATOR #### Defined in -[src/models/AssetPrice.ts:46](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L46) +[src/models/AssetPrice.ts:46](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L46) ---- +___ ### getAmountsString @@ -209,9 +209,9 @@ AssetPrice.NETWORK_FEE_DENOMINATOR #### Defined in -[src/models/AssetPrice.ts:104](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L104) +[src/models/AssetPrice.ts:104](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L104) ---- +___ ### getReceivers @@ -223,9 +223,9 @@ AssetPrice.NETWORK_FEE_DENOMINATOR #### Defined in -[src/models/AssetPrice.ts:50](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L50) +[src/models/AssetPrice.ts:50](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L50) ---- +___ ### getReceiversString @@ -237,9 +237,9 @@ AssetPrice.NETWORK_FEE_DENOMINATOR #### Defined in -[src/models/AssetPrice.ts:110](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L110) +[src/models/AssetPrice.ts:110](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L110) ---- +___ ### getRewards @@ -251,9 +251,9 @@ AssetPrice.NETWORK_FEE_DENOMINATOR #### Defined in -[src/models/AssetPrice.ts:42](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L42) +[src/models/AssetPrice.ts:42](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L42) ---- +___ ### getTokenAddress @@ -265,9 +265,9 @@ AssetPrice.NETWORK_FEE_DENOMINATOR #### Defined in -[src/models/AssetPrice.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L67) +[src/models/AssetPrice.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L67) ---- +___ ### getTotalPrice @@ -279,9 +279,9 @@ AssetPrice.NETWORK_FEE_DENOMINATOR #### Defined in -[src/models/AssetPrice.ts:38](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L38) +[src/models/AssetPrice.ts:38](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L38) ---- +___ ### setReceiver @@ -289,10 +289,10 @@ AssetPrice.NETWORK_FEE_DENOMINATOR #### Parameters -| Name | Type | -| :--------- | :------- | +| Name | Type | +| :------ | :------ | | `receiver` | `string` | -| `amount` | `bigint` | +| `amount` | `bigint` | #### Returns @@ -300,9 +300,9 @@ AssetPrice.NETWORK_FEE_DENOMINATOR #### Defined in -[src/models/AssetPrice.ts:54](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L54) +[src/models/AssetPrice.ts:54](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L54) ---- +___ ### setTokenAddress @@ -310,8 +310,8 @@ AssetPrice.NETWORK_FEE_DENOMINATOR #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `address` | `string` | #### Returns @@ -320,9 +320,9 @@ AssetPrice.NETWORK_FEE_DENOMINATOR #### Defined in -[src/models/AssetPrice.ts:62](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L62) +[src/models/AssetPrice.ts:62](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L62) ---- +___ ### toString @@ -334,9 +334,9 @@ AssetPrice.NETWORK_FEE_DENOMINATOR #### Defined in -[src/models/AssetPrice.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L115) +[src/models/AssetPrice.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L115) ---- +___ ### sumAmounts @@ -344,8 +344,8 @@ AssetPrice.NETWORK_FEE_DENOMINATOR #### Parameters -| Name | Type | -| :-------- | :--------- | +| Name | Type | +| :------ | :------ | | `amounts` | `bigint`[] | #### Returns @@ -354,4 +354,4 @@ AssetPrice.NETWORK_FEE_DENOMINATOR #### Defined in -[src/models/AssetPrice.ts:34](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetPrice.ts#L34) +[src/models/AssetPrice.ts:34](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetPrice.ts#L34) diff --git a/docs/nevermined-sdk/api-reference/classes/AssetPublicationOptions.md b/docs/nevermined-sdk/api-reference/classes/AssetPublicationOptions.md index f6011b5a5f..bc9893297e 100644 --- a/docs/nevermined-sdk/api-reference/classes/AssetPublicationOptions.md +++ b/docs/nevermined-sdk/api-reference/classes/AssetPublicationOptions.md @@ -31,9 +31,9 @@ #### Defined in -[src/types/MetadataTypes.ts:41](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L41) +[src/types/MetadataTypes.ts:41](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L41) ---- +___ ### metadata @@ -41,4 +41,4 @@ #### Defined in -[src/types/MetadataTypes.ts:40](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L40) +[src/types/MetadataTypes.ts:40](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L40) diff --git a/docs/nevermined-sdk/api-reference/classes/AssetsApi.md b/docs/nevermined-sdk/api-reference/classes/AssetsApi.md index 4909df28be..101c34d79a 100644 --- a/docs/nevermined-sdk/api-reference/classes/AssetsApi.md +++ b/docs/nevermined-sdk/api-reference/classes/AssetsApi.md @@ -76,8 +76,8 @@ Creates a new AssetsApi #### Parameters -| Name | Type | Description | -| :------- | :---------------------------------------------------------- | :--------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Configuration of the Nevermined instance | #### Returns @@ -92,7 +92,7 @@ Creates a new AssetsApi #### Defined in -[src/nevermined/api/AssetsApi.ts:87](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L87) +[src/nevermined/api/AssetsApi.ts:87](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L87) ## Properties @@ -104,9 +104,9 @@ Utilities about the providers associated to an asset #### Defined in -[src/nevermined/api/AssetsApi.ts:80](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L80) +[src/nevermined/api/AssetsApi.ts:80](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L80) ---- +___ ### servicePlugin @@ -122,7 +122,7 @@ Utilities about the providers associated to an asset #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L39) +[src/nevermined/api/RegistryBaseApi.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L39) ## Accessors @@ -140,9 +140,9 @@ RegistryBaseApi.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -158,9 +158,9 @@ RegistryBaseApi.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -176,9 +176,9 @@ RegistryBaseApi.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -194,9 +194,9 @@ RegistryBaseApi.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -212,9 +212,9 @@ RegistryBaseApi.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -230,9 +230,9 @@ RegistryBaseApi.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -248,9 +248,9 @@ RegistryBaseApi.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -266,9 +266,9 @@ RegistryBaseApi.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -278,69 +278,69 @@ RegistryBaseApi.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -348,9 +348,9 @@ RegistryBaseApi.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -360,38 +360,38 @@ RegistryBaseApi.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -399,41 +399,41 @@ RegistryBaseApi.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods ### access -▸ **access**(`agreementId`, `did`, `serviceReference`, `from`, `resultPath?`, `fileIndex?`, `buyer?`, `babysig?`): `Promise`\<`string` \| `true`\> +▸ **access**(`agreementId`, `did`, `serviceReference`, `from`, `resultPath?`, `fileIndex?`, `buyer?`, `babysig?`): `Promise`\<`string` \| ``true``\> Having previously ordered an "access" service (referenced via an "agreementId"). This method allows to download the assets associated to that service. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------------------------- | -| `agreementId` | `string` | `undefined` | The unique identifier of the order placed for a service | -| `did` | `string` | `undefined` | Unique identifier of the asset ordered | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `undefined` | The service to download. By default is the access service, but it can be specified the service.index to refer a different specific service | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account of the user who ordered the asset and is downloading the files | -| `resultPath?` | `string` | `undefined` | Where the files will be downloaded | -| `fileIndex` | `number` | `-1` | The file to download. If not given or is -1 it will download all of them. | -| `buyer?` | `string` | `undefined` | Key which represent the buyer | -| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | An elliptic curve signature | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | The unique identifier of the order placed for a service | +| `did` | `string` | `undefined` | Unique identifier of the asset ordered | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `undefined` | The service to download. By default is the access service, but it can be specified the service.index to refer a different specific service | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account of the user who ordered the asset and is downloading the files | +| `resultPath?` | `string` | `undefined` | Where the files will be downloaded | +| `fileIndex` | `number` | `-1` | The file to download. If not given or is -1 it will download all of them. | +| `buyer?` | `string` | `undefined` | Key which represent the buyer | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | An elliptic curve signature | #### Returns -`Promise`\<`string` \| `true`\> +`Promise`\<`string` \| ``true``\> The result path or true if everything went okay #### Defined in -[src/nevermined/api/AssetsApi.ts:217](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L217) +[src/nevermined/api/AssetsApi.ts:217](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L217) ---- +___ ### addRating @@ -443,14 +443,14 @@ Given a DID, it adds a vote to the asset curation information. #### Parameters -| Name | Type | Default value | Description | -| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `newRating` | `number` | `undefined` | New average rating of the asset | -| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `newRating` | `number` | `undefined` | New average rating of the asset | +| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -464,9 +464,9 @@ Given a DID, it adds a vote to the asset curation information. #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:534](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L534) +[src/nevermined/api/RegistryBaseApi.ts:534](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L534) ---- +___ ### consumerAssets @@ -476,8 +476,8 @@ Returns the assets of a consumer. #### Parameters -| Name | Type | Description | -| :---------------- | :------- | :---------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `consumerAccount` | `string` | Consumer address. | #### Returns @@ -488,9 +488,9 @@ List of DIDs. #### Defined in -[src/nevermined/api/AssetsApi.ts:360](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L360) +[src/nevermined/api/AssetsApi.ts:360](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L360) ---- +___ ### create @@ -500,16 +500,16 @@ Registers a new asset in Nevermined. You can find more information about how different data is stored in Nevermined here: [https://docs.nevermined.io/docs/architecture/nevermined-data](https://docs.nevermined.io/docs/architecture/nevermined-data) -- + * #### Parameters -| Name | Type | Description | -| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | -| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | +| Name | Type | Description | +| :------ | :------ | :------ | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | | `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -523,11 +523,15 @@ The metadata of the asset created (DDO) ```ts const assetAttributes = AssetAttributes.getInstance({ - metadata, - price: assetPrice, - serviceTypes: ['sales', 'access'], + metadata, + price: assetPrice, + serviceTypes: ['sales', 'access'] }) -const ddo = await nevermined.assets.create(assetAttributes, publisher, PublishMetadata.IPFS) +const ddo = await nevermined.assets.create( + assetAttributes, + publisher, + PublishMetadata.IPFS +) ``` **`See`** @@ -536,9 +540,9 @@ const ddo = await nevermined.assets.create(assetAttributes, publisher, PublishMe #### Defined in -[src/nevermined/api/AssetsApi.ts:134](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L134) +[src/nevermined/api/AssetsApi.ts:134](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L134) ---- +___ ### download @@ -549,15 +553,15 @@ This method only can be called successfully by the owner of the asset or a provi #### Parameters -| Name | Type | Default value | Description | -| :------------ | :------------------------------------------------ | :------------ | :----------------------------------------- | -| `did` | `string` | `undefined` | The Decentralized Identifier of the asset. | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account of the asset owner | -| `resultPath?` | `string` | `undefined` | Path to be the files downloader | -| `fileIndex` | `number` | `-1` | The index of the file | -| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | `'access'` | Service type. 'access' by default | -| `buyer?` | `string` | `undefined` | Key which represent the buyer | -| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | An elliptic curve signature | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | The Decentralized Identifier of the asset. | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account of the asset owner | +| `resultPath?` | `string` | `undefined` | Path to be the files downloader | +| `fileIndex` | `number` | `-1` | The index of the file | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | `'access'` | Service type. 'access' by default | +| `buyer?` | `string` | `undefined` | Key which represent the buyer | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | An elliptic curve signature | #### Returns @@ -567,9 +571,9 @@ Status, path destination if resultPath is provided #### Defined in -[src/nevermined/api/AssetsApi.ts:390](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L390) +[src/nevermined/api/AssetsApi.ts:390](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L390) ---- +___ ### getNftContractAddress @@ -579,9 +583,9 @@ Get the NFT contract address associated with a Nevermined asset. #### Parameters -| Name | Type | Default value | Description | -| :------------ | :------------------------------------------------ | :------------- | :------------------------------------------------------- | -| `ddo` | [`DDO`](DDO.md) | `undefined` | The DDO of the asset. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | `undefined` | The DDO of the asset. | | `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service type to use to get the NFT contract address. | #### Returns @@ -602,9 +606,9 @@ DDOError - If the NFT contract address is not found in the DDO. #### Defined in -[src/nevermined/api/AssetsApi.ts:509](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L509) +[src/nevermined/api/AssetsApi.ts:509](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L509) ---- +___ ### getPermissions @@ -614,10 +618,10 @@ Checks if an account with a specific address has permissions to a specific asset #### Parameters -| Name | Type | Description | -| :-------- | :------- | :---------------------------------------------------------- | -| `did` | `string` | The unique identifier of the asset to check the permissions | -| `address` | `string` | The address of the account to check the permissions | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The unique identifier of the asset to check the permissions | +| `address` | `string` | The address of the account to check the permissions | #### Returns @@ -627,9 +631,9 @@ True if the address has permissions on the asset #### Defined in -[src/nevermined/api/AssetsApi.ts:491](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L491) +[src/nevermined/api/AssetsApi.ts:491](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L491) ---- +___ ### grantPermissions @@ -640,12 +644,12 @@ Only can be called by the asset owner. #### Parameters -| Name | Type | Description | -| :------------- | :---------------------------------------------- | :------------------------------------------------------------- | -| `did` | `string` | The unique identifier of the assert | -| `grantAddress` | `string` | The account address to grant the permissions | -| `from` | [`NvmAccount`](NvmAccount.md) | Account sending the request. It must be the owner of the asset | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The unique identifier of the assert | +| `grantAddress` | `string` | The account address to grant the permissions | +| `from` | [`NvmAccount`](NvmAccount.md) | Account sending the request. It must be the owner of the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -653,9 +657,9 @@ Only can be called by the asset owner. #### Defined in -[src/nevermined/api/AssetsApi.ts:448](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L448) +[src/nevermined/api/AssetsApi.ts:448](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L448) ---- +___ ### list @@ -666,13 +670,13 @@ In a Nevermined environment, when an asset is unlisted, it is not possible to be #### Parameters -| Name | Type | Default value | Description | -| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -686,9 +690,9 @@ In a Nevermined environment, when an asset is unlisted, it is not possible to be #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:482](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L482) +[src/nevermined/api/RegistryBaseApi.ts:482](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L482) ---- +___ ### order @@ -701,12 +705,12 @@ for that service. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------ | :-------------------------------------------------------------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Unique identifier of the asset to order | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'access'` | The service to order. By default is the access service, but it can be specified the service.index to refer a different specific service | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account of the user ordering the asset | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Unique identifier of the asset to order | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'access'` | The service to order. By default is the access service, but it can be specified the service.index to refer a different specific service | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account of the user ordering the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -716,9 +720,9 @@ The agreement ID identifying the order #### Defined in -[src/nevermined/api/AssetsApi.ts:194](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L194) +[src/nevermined/api/AssetsApi.ts:194](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L194) ---- +___ ### orderAsset @@ -729,12 +733,12 @@ then sends the request to the publisher via the service endpoint (Node http serv #### Parameters -| Name | Type | Description | -| :----------------- | :------------------------------------------------------------ | :--------------------- | -| `did` | `string` | Decentralized ID. | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | -| `from` | [`NvmAccount`](NvmAccount.md) | Consumer account. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | Decentralized ID. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `from` | [`NvmAccount`](NvmAccount.md) | Consumer account. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -748,9 +752,9 @@ The agreement ID. #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:585](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L585) +[src/nevermined/api/RegistryBaseApi.ts:585](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L585) ---- +___ ### owner @@ -760,8 +764,8 @@ Returns the owner of an asset. #### Parameters -| Name | Type | Description | -| :---- | :------- | :---------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `did` | `string` | Decentralized ID. | #### Returns @@ -772,9 +776,9 @@ The address of the owner of the asset #### Defined in -[src/nevermined/api/AssetsApi.ts:276](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L276) +[src/nevermined/api/AssetsApi.ts:276](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L276) ---- +___ ### ownerAssets @@ -784,8 +788,8 @@ Returns the assets owned by an address #### Parameters -| Name | Type | Description | -| :------ | :------- | :------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `owner` | `string` | The address to check | #### Returns @@ -796,9 +800,9 @@ List of DIDs owned by the address #### Defined in -[src/nevermined/api/AssetsApi.ts:305](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L305) +[src/nevermined/api/AssetsApi.ts:305](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L305) ---- +___ ### ownerSignature @@ -808,8 +812,8 @@ Returns the owner from the signature included in the DDO. #### Parameters -| Name | Type | Description | -| :---- | :------- | :---------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `did` | `string` | Decentralized ID. | #### Returns @@ -820,9 +824,9 @@ The address of the owner of the asset #### Defined in -[src/nevermined/api/AssetsApi.ts:285](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L285) +[src/nevermined/api/AssetsApi.ts:285](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L285) ---- +___ ### registerNeverminedAsset @@ -833,13 +837,13 @@ via the Nevermined APIs directly. It must accessed via the `assets`, `compute`, #### Parameters -| Name | Type | Description | -| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | -| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | +| Name | Type | Description | +| :------ | :------ | :------ | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | | `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -857,9 +861,9 @@ The metadata of the asset created (DDO) #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L52) +[src/nevermined/api/RegistryBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L52) ---- +___ ### resolve @@ -869,9 +873,9 @@ Returns a DDO by DID. Depending of the resolution policy it prioritize the Metad #### Parameters -| Name | Type | Default value | Description | -| :------- | :------------------------------------------------- | :---------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID. | | `policy` | [`DIDResolvePolicy`](../enums/DIDResolvePolicy.md) | `DIDResolvePolicy.NoRegistry` | It specifies the resolve policy to apply. It allows to select that priorities during the asset resolution via Metadata API or Immutable URLs (IPFS, Filecoin, etc) | #### Returns @@ -882,9 +886,9 @@ Returns a DDO by DID. Depending of the resolution policy it prioritize the Metad #### Defined in -[src/nevermined/api/AssetsApi.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L100) +[src/nevermined/api/AssetsApi.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L100) ---- +___ ### resolveAsset @@ -895,9 +899,9 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Parameters -| Name | Type | Default value | Description | -| :------- | :------------------------------------------------- | :---------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID. | | `policy` | [`DIDResolvePolicy`](../enums/DIDResolvePolicy.md) | `DIDResolvePolicy.MetadataAPIFirst` | It specifies the resolve policy to apply. It allows to select that priorities during the asset resolution via Metadata API or Immutable URLs (IPFS, Filecoin, etc) | #### Returns @@ -912,9 +916,9 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:324](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L324) +[src/nevermined/api/RegistryBaseApi.ts:324](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L324) ---- +___ ### retire @@ -924,8 +928,8 @@ Retires the metadata of an asset from the Marketplace API. This allows the owner #### Parameters -| Name | Type | Description | -| :---- | :------- | :--------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `did` | `string` | the unique identifier of the asset | #### Returns @@ -936,9 +940,9 @@ the HTTP response #### Defined in -[src/nevermined/api/AssetsApi.ts:373](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L373) +[src/nevermined/api/AssetsApi.ts:373](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L373) ---- +___ ### revokePermissions @@ -949,12 +953,12 @@ Only can be called by the asset owner. #### Parameters -| Name | Type | Description | -| :-------------- | :---------------------------------------------- | :------------------------------------------------------------- | -| `did` | `string` | The unique identifier of the assert | -| `revokeAddress` | `string` | The account address to revoke the permissions | -| `from` | [`NvmAccount`](NvmAccount.md) | Account sending the request. It must be the owner of the asset | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The unique identifier of the assert | +| `revokeAddress` | `string` | The account address to revoke the permissions | +| `from` | [`NvmAccount`](NvmAccount.md) | Account sending the request. It must be the owner of the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -962,9 +966,9 @@ Only can be called by the asset owner. #### Defined in -[src/nevermined/api/AssetsApi.ts:471](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L471) +[src/nevermined/api/AssetsApi.ts:471](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L471) ---- +___ ### setInstanceConfig @@ -972,8 +976,8 @@ Only can be called by the asset owner. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -986,9 +990,9 @@ Only can be called by the asset owner. #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### transferOwnership @@ -998,13 +1002,13 @@ Transfer ownership of an asset. #### Parameters -| Name | Type | Description | -| :----------- | :---------------------------------------------- | :--------------------------------------------------------- | -| `did` | `string` | Asset DID. | -| `newOwner` | `string` | Ethereum address of the new owner of the DID. | -| `from` | [`NvmAccount`](NvmAccount.md) | Account owning the DID and doing the transfer of ownership | -| `newUserId?` | `string` | User Id of the new user getting the ownership of the asset | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | Asset DID. | +| `newOwner` | `string` | Ethereum address of the new owner of the DID. | +| `from` | [`NvmAccount`](NvmAccount.md) | Account owning the DID and doing the transfer of ownership | +| `newUserId?` | `string` | User Id of the new user getting the ownership of the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -1014,9 +1018,9 @@ Returns transaction receipt. #### Defined in -[src/nevermined/api/AssetsApi.ts:318](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L318) +[src/nevermined/api/AssetsApi.ts:318](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L318) ---- +___ ### update @@ -1026,13 +1030,13 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Parameters -| Name | Type | Default value | Description | -| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -1044,18 +1048,18 @@ Given a DID, updates the metadata associated to the asset. It also can upload th ```ts const ddoUpdated = await nevermined.assets.update( - ddo.shortId(), - updatedMetadata, - publisher, - PublishMetadata.IPFS, + ddo.shortId(), + updatedMetadata, + publisher, + PublishMetadata.IPFS ) ``` #### Defined in -[src/nevermined/api/AssetsApi.ts:172](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L172) +[src/nevermined/api/AssetsApi.ts:172](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L172) ---- +___ ### updateAsset @@ -1065,13 +1069,13 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Parameters -| Name | Type | Default value | Description | -| :----------------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -1085,9 +1089,9 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:367](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L367) +[src/nevermined/api/RegistryBaseApi.ts:367](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L367) ---- +___ ### getInstance @@ -1095,8 +1099,8 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -1109,9 +1113,9 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### getServicePlugin @@ -1121,8 +1125,8 @@ Initializes the default Nevermined service plugins and return that instance #### Parameters -| Name | Type | Description | -| :------- | :---------------------------------------------------------- | :---------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Nevermined config | #### Returns @@ -1131,12 +1135,12 @@ Initializes the default Nevermined service plugins and return that instance The Nevermined Service Plugin instance -| Name | Type | -| :----------- | :-------------------------------------------------------------------- | -| `access` | [`AccessService`](AccessService.md) | -| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | -| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | -| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | +| Name | Type | +| :------ | :------ | +| `access` | [`AccessService`](AccessService.md) | +| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | +| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | +| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | #### Inherited from @@ -1144,9 +1148,9 @@ The Nevermined Service Plugin instance #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:640](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L640) +[src/nevermined/api/RegistryBaseApi.ts:640](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L640) ---- +___ ### setInstanceConfig @@ -1154,15 +1158,15 @@ The Nevermined Service Plugin instance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1175,4 +1179,4 @@ The Nevermined Service Plugin instance #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/BabyjubPublicKey.md b/docs/nevermined-sdk/api-reference/classes/BabyjubPublicKey.md index 26eb16771d..6f199c542f 100644 --- a/docs/nevermined-sdk/api-reference/classes/BabyjubPublicKey.md +++ b/docs/nevermined-sdk/api-reference/classes/BabyjubPublicKey.md @@ -25,10 +25,10 @@ #### Parameters -| Name | Type | -| :--- | :------- | -| `x` | `string` | -| `y` | `string` | +| Name | Type | +| :------ | :------ | +| `x` | `string` | +| `y` | `string` | #### Returns @@ -36,7 +36,7 @@ #### Defined in -[src/models/KeyTransfer.ts:8](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/KeyTransfer.ts#L8) +[src/models/KeyTransfer.ts:8](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/KeyTransfer.ts#L8) ## Properties @@ -46,9 +46,9 @@ #### Defined in -[src/models/KeyTransfer.ts:5](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/KeyTransfer.ts#L5) +[src/models/KeyTransfer.ts:5](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/KeyTransfer.ts#L5) ---- +___ ### y @@ -56,7 +56,7 @@ #### Defined in -[src/models/KeyTransfer.ts:6](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/KeyTransfer.ts#L6) +[src/models/KeyTransfer.ts:6](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/KeyTransfer.ts#L6) ## Methods @@ -70,4 +70,4 @@ #### Defined in -[src/models/KeyTransfer.ts:13](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/KeyTransfer.ts#L13) +[src/models/KeyTransfer.ts:13](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/KeyTransfer.ts#L13) diff --git a/docs/nevermined-sdk/api-reference/classes/BaseTemplate.md b/docs/nevermined-sdk/api-reference/classes/BaseTemplate.md index 58d9d2210f..fd3c9bde98 100644 --- a/docs/nevermined-sdk/api-reference/classes/BaseTemplate.md +++ b/docs/nevermined-sdk/api-reference/classes/BaseTemplate.md @@ -4,10 +4,10 @@ ## Type parameters -| Name | Type | -| :------- | :------------------------------------------------ | -| `Params` | `Params` | -| `S` | extends [`Service`](../code-reference.md#service) | +| Name | Type | +| :------ | :------ | +| `Params` | `Params` | +| `S` | extends [`Service`](../code-reference.md#service) | ## Hierarchy @@ -116,15 +116,15 @@ #### Type parameters -| Name | Type | -| :------- | :-------------------------------------------------------- | -| `Params` | `Params` | -| `S` | extends [`ServiceCommon`](../interfaces/ServiceCommon.md) | +| Name | Type | +| :------ | :------ | +| `Params` | `Params` | +| `S` | extends [`ServiceCommon`](../interfaces/ServiceCommon.md) | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -137,7 +137,7 @@ #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) ## Properties @@ -151,9 +151,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -165,9 +165,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -179,9 +179,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -193,9 +193,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -207,7 +207,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -225,9 +225,9 @@ AgreementTemplate.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -243,9 +243,9 @@ AgreementTemplate.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -261,9 +261,9 @@ AgreementTemplate.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -279,9 +279,9 @@ AgreementTemplate.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -297,9 +297,9 @@ AgreementTemplate.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -315,9 +315,9 @@ AgreementTemplate.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -333,9 +333,9 @@ AgreementTemplate.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -351,9 +351,9 @@ AgreementTemplate.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -363,69 +363,69 @@ AgreementTemplate.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -433,9 +433,9 @@ AgreementTemplate.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -445,38 +445,38 @@ AgreementTemplate.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -484,7 +484,7 @@ AgreementTemplate.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -494,8 +494,8 @@ AgreementTemplate.walletClient #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | #### Returns @@ -508,9 +508,9 @@ AgreementTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:114](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L114) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:114](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L114) ---- +___ ### agreementId @@ -518,10 +518,10 @@ AgreementTemplate.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `agreementIdSeed` | `string` | -| `creator` | `string` | +| `creator` | `string` | #### Returns @@ -533,9 +533,9 @@ AgreementTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L202) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L202) ---- +___ ### call @@ -544,16 +544,16 @@ AgreementTemplate.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -565,9 +565,9 @@ AgreementTemplate.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### conditions @@ -579,9 +579,9 @@ AgreementTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L42) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L42) ---- +___ ### createAgreement @@ -589,16 +589,16 @@ AgreementTemplate.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `extraArgs` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `extraArgs` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -610,9 +610,9 @@ AgreementTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L73) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L73) ---- +___ ### createAgreementAndPay @@ -620,21 +620,21 @@ AgreementTemplate.walletClient #### Parameters -| Name | Type | -| :--------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `accessConsumer` | `string` | -| `condIdx` | `number` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `bigint`[] | -| `receivers` | `string`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `accessConsumer` | `string` | +| `condIdx` | `number` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -646,9 +646,9 @@ AgreementTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L98) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L98) ---- +___ ### createAgreementFromDDO @@ -658,14 +658,14 @@ Create a new agreement using the data of a DDO. #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :---------- | -| `agreementIdSeed` | `string` | - | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `parameters` | `Params` | | -| `consumer` | [`NvmAccount`](NvmAccount.md) | - | -| `timeOuts?` | `number`[] | - | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementIdSeed` | `string` | - | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `parameters` | `Params` | | +| `consumer` | [`NvmAccount`](NvmAccount.md) | - | +| `timeOuts?` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | #### Returns @@ -679,9 +679,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L211) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L211) ---- +___ ### createAgreementWithPaymentFromDDO @@ -689,16 +689,16 @@ true if the call was successful. #### Parameters -| Name | Type | -| :----------------- | :------------------------------------------------------------------------------------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | -| `parameters` | `Params` | -| `consumer` | [`NvmAccount`](NvmAccount.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | -| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | +| Name | Type | +| :------ | :------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `Params` | +| `consumer` | [`NvmAccount`](NvmAccount.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | #### Returns @@ -710,9 +710,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L240) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L240) ---- +___ ### createService @@ -720,13 +720,13 @@ true if the call was successful. #### Parameters -| Name | Type | -| :------------------ | :---------------------------------------------------------------------------- | -| `publisher` | [`NvmAccount`](NvmAccount.md) | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | -| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | -| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | +| Name | Type | +| :------ | :------ | +| `publisher` | [`NvmAccount`](NvmAccount.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | #### Returns @@ -738,9 +738,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L48) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L48) ---- +___ ### description @@ -752,9 +752,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:41](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L41) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:41](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L41) ---- +___ ### extraGen @@ -762,8 +762,8 @@ true if the call was successful. #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | #### Returns @@ -772,9 +772,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) ---- +___ ### getAgreementCreatedEvent @@ -784,8 +784,8 @@ Generates and returns the agreement creation event. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns @@ -800,29 +800,29 @@ Agreement created event. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L450) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L450) ---- +___ ### getAgreementData -▸ **getAgreementData**(`agreementId`): `Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> +▸ **getAgreementData**(`agreementId`): `Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns -`Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> +`Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L29) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L29) ---- +___ ### getAgreementIdsFromDDO @@ -832,12 +832,12 @@ Get agreement conditions IDs. #### Parameters -| Name | Type | Description | -| :------------ | :-------------- | :------------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `Params` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | Agreement ID. | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `creator` | `string` | - | +| `params` | `Params` | - | #### Returns @@ -851,25 +851,25 @@ The condition IDs. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L169) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L169) ---- +___ ### getAgreementStatus -▸ **getAgreementStatus**(`agreementId`): `Promise`\<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> +▸ **getAgreementStatus**(`agreementId`): `Promise`\<``false`` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> Returns the status of the conditions. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns -`Promise`\<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> +`Promise`\<``false`` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> The conditions status. @@ -879,9 +879,9 @@ The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L331) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L331) ---- +___ ### getAgreementsForDID @@ -889,8 +889,8 @@ The conditions status. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -903,9 +903,9 @@ The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L476) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L476) ---- +___ ### getConditionTypes @@ -925,9 +925,9 @@ A list of condition addresses. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L137) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L137) ---- +___ ### getConditions @@ -947,9 +947,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L148) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L148) ---- +___ ### getFromAddress @@ -957,8 +957,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -971,9 +971,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getServiceAgreementTemplate @@ -989,9 +989,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:307](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L307) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:307](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L307) ---- +___ ### getServiceAgreementTemplateConditionByRef @@ -999,8 +999,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `ref` | `string` | #### Returns @@ -1013,9 +1013,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L314) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L314) ---- +___ ### getServiceAgreementTemplateConditions @@ -1031,17 +1031,17 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L309) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L309) ---- +___ ### getServiceAgreementTemplateDependencies -▸ **getServiceAgreementTemplateDependencies**(): `Promise`\<\{ `[condition: string]`: `string`[]; }\> +▸ **getServiceAgreementTemplateDependencies**(): `Promise`\<\{ `[condition: string]`: `string`[]; }\> #### Returns -`Promise`\<\{ `[condition: string]`: `string`[]; }\> +`Promise`\<\{ `[condition: string]`: `string`[]; }\> #### Inherited from @@ -1049,24 +1049,24 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L321) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L321) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -1074,9 +1074,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -1084,11 +1084,11 @@ A list of condition contracts. #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -1100,9 +1100,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instanceFromDDO @@ -1110,13 +1110,13 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :---------------- | :-------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `Params` | -| `serviceIndex?` | `number` | +| Name | Type | +| :------ | :------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `parameters` | `Params` | +| `serviceIndex?` | `number` | #### Returns @@ -1128,9 +1128,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:179](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L179) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:179](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L179) ---- +___ ### lockConditionIndex @@ -1146,9 +1146,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L57) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L57) ---- +___ ### lockTokens @@ -1156,12 +1156,12 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `tokenAddress` | `any` | +| `amounts` | `any` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1173,9 +1173,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L382) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L382) ---- +___ ### name @@ -1187,9 +1187,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:40](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L40) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:40](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L40) ---- +___ ### params @@ -1197,8 +1197,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -1211,9 +1211,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:55](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L55) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:55](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L55) ---- +___ ### paramsGen @@ -1223,8 +1223,8 @@ Specialize params #### Parameters -| Name | Type | Description | -| :------- | :------------------------------------------------------ | :----------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | Generic parameters | #### Returns @@ -1233,9 +1233,9 @@ Specialize params #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) ---- +___ ### paymentData @@ -1243,8 +1243,8 @@ Specialize params #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | #### Returns @@ -1257,9 +1257,9 @@ Specialize params #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L61) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L61) ---- +___ ### printAgreementStatus @@ -1269,8 +1269,8 @@ Prints the agreement status. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns @@ -1283,9 +1283,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L418) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L418) ---- +___ ### process @@ -1293,11 +1293,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :---------- | :------------------------------------------------------ | -| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1309,9 +1309,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:126](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L126) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:126](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L126) ---- +___ ### send @@ -1319,12 +1319,12 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1336,9 +1336,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -1346,12 +1346,12 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1363,9 +1363,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### service @@ -1381,9 +1381,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:187](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L187) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:187](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L187) ---- +___ ### serviceEndpoint @@ -1395,9 +1395,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L44) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L44) ---- +___ ### setInstanceConfig @@ -1405,8 +1405,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1419,9 +1419,9 @@ Prints the agreement status. #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1429,8 +1429,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1443,9 +1443,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### standardContext @@ -1453,11 +1453,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :-------------- | :-------------- | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `serviceIndex?` | `number` | +| Name | Type | +| :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `serviceIndex?` | `number` | #### Returns @@ -1469,9 +1469,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L189) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L189) ---- +___ ### track @@ -1479,11 +1479,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :----------- | :------------------------------------------------------ | -| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `_from` | [`NvmAccount`](NvmAccount.md) | -| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `_from` | [`NvmAccount`](NvmAccount.md) | +| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1495,9 +1495,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:118](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L118) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:118](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L118) ---- +___ ### validateAgreement @@ -1505,14 +1505,14 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `Params` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `extra` | `any` | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreement_id` | `string` | +| `did` | `string` | +| `params` | `Params` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `extra` | `any` | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1520,9 +1520,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L141) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L141) ---- +___ ### getInstance @@ -1530,18 +1530,18 @@ Prints the agreement status. #### Type parameters -| Name | -| :------- | +| Name | +| :------ | | `Params` | #### Parameters -| Name | Type | Default value | -| :--------------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `templateContractName` | `string` | `undefined` | -| `templateClass` | `any` | `undefined` | -| `optional` | `boolean` | `false` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `templateContractName` | `string` | `undefined` | +| `templateClass` | `any` | `undefined` | +| `optional` | `boolean` | `false` | #### Returns @@ -1553,9 +1553,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:38](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L38) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:38](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L38) ---- +___ ### setInstanceConfig @@ -1563,15 +1563,15 @@ Prints the agreement status. #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1584,4 +1584,4 @@ Prints the agreement status. #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/BlockchainViemUtils.md b/docs/nevermined-sdk/api-reference/classes/BlockchainViemUtils.md index fcf8587b9a..55c3b6defd 100644 --- a/docs/nevermined-sdk/api-reference/classes/BlockchainViemUtils.md +++ b/docs/nevermined-sdk/api-reference/classes/BlockchainViemUtils.md @@ -48,8 +48,8 @@ This class uses Viem library to interact with the blockchain. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -62,7 +62,7 @@ This class uses Viem library to interact with the blockchain. #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:60](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L60) +[src/nevermined/utils/BlockchainViemUtils.ts:60](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L60) ## Accessors @@ -80,9 +80,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -98,9 +98,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -116,9 +116,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -134,9 +134,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -152,9 +152,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -170,9 +170,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -188,9 +188,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -206,9 +206,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -218,69 +218,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -288,9 +288,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -300,38 +300,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -339,7 +339,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -351,8 +351,8 @@ Returns true of contract exists else it throws. #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `address` | `string` | #### Returns @@ -363,38 +363,38 @@ true if the contract exists. #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:131](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L131) +[src/nevermined/utils/BlockchainViemUtils.ts:131](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L131) ---- +___ ### deployAbi -▸ **deployAbi**(`artifact`, `from`, `args?`): `Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> +▸ **deployAbi**(`artifact`, `from`, `args?`): `Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> Given an artifact, it deploys the contract and returns the contract instance. #### Parameters -| Name | Type | Default value | Description | -| :------------------ | :---------------------------- | :------------ | :---------------------------------------------------------------- | -| `artifact` | `Object` | `undefined` | the contract artifact | -| `artifact.abi` | `Abi` | `undefined` | - | -| `artifact.bytecode` | \`0x$\{string}\` | `undefined` | - | -| `artifact.name?` | `string` | `undefined` | - | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | the deployer account | -| `args` | `string`[] | `[]` | parameters to be passed to the contract during the initialization | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `artifact` | `Object` | `undefined` | the contract artifact | +| `artifact.abi` | `Abi` | `undefined` | - | +| `artifact.bytecode` | \`0x$\{string}\` | `undefined` | - | +| `artifact.name?` | `string` | `undefined` | - | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | the deployer account | +| `args` | `string`[] | `[]` | parameters to be passed to the contract during the initialization | #### Returns -`Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> +`Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> a contract instance #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:72](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L72) +[src/nevermined/utils/BlockchainViemUtils.ts:72](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L72) ---- +___ ### getTransactionReceipt @@ -405,10 +405,10 @@ If this function is called before the transaction is mined, it will iterate a fe #### Parameters -| Name | Type | Default value | Description | -| :---------- | :--------------- | :------------ | :------------------- | -| `txHash` | \`0x$\{string}\` | `undefined` | the transaction hash | -| `iteration` | `number` | `1` | the iteration number | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `txHash` | \`0x$\{string}\` | `undefined` | the transaction hash | +| `iteration` | `number` | `1` | the iteration number | #### Returns @@ -418,34 +418,34 @@ the transaction receipt #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:103](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L103) +[src/nevermined/utils/BlockchainViemUtils.ts:103](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L103) ---- +___ ### loadContract -▸ **loadContract**(`contractAddress`, `abi`): `Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> +▸ **loadContract**(`contractAddress`, `abi`): `Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> Given an already deployed contract address and the ABI, it returns the contract instance. #### Parameters -| Name | Type | Description | -| :---------------- | :------- | :-------------------- | -| `contractAddress` | `string` | the contract address | -| `abi` | `Abi` | the contract artifact | +| Name | Type | Description | +| :------ | :------ | :------ | +| `contractAddress` | `string` | the contract address | +| `abi` | `Abi` | the contract artifact | #### Returns -`Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> +`Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> a contract instance #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:86](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L86) +[src/nevermined/utils/BlockchainViemUtils.ts:86](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L86) ---- +___ ### setInstanceConfig @@ -453,8 +453,8 @@ a contract instance #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -467,9 +467,9 @@ a contract instance #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### getInstance @@ -477,8 +477,8 @@ a contract instance #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -491,9 +491,9 @@ a contract instance #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -501,15 +501,15 @@ a contract instance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -522,4 +522,4 @@ a contract instance #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/Bookmarks.md b/docs/nevermined-sdk/api-reference/classes/Bookmarks.md index 0300faa0d7..f667e76684 100644 --- a/docs/nevermined-sdk/api-reference/classes/Bookmarks.md +++ b/docs/nevermined-sdk/api-reference/classes/Bookmarks.md @@ -49,8 +49,8 @@ #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -63,7 +63,7 @@ #### Defined in -[src/services/metadata/MarketplaceAPI.ts:7](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L7) +[src/services/metadata/MarketplaceAPI.ts:7](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L7) ## Accessors @@ -81,9 +81,9 @@ MarketplaceApi.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -99,9 +99,9 @@ MarketplaceApi.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -117,9 +117,9 @@ MarketplaceApi.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -135,9 +135,9 @@ MarketplaceApi.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -153,9 +153,9 @@ MarketplaceApi.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -171,9 +171,9 @@ MarketplaceApi.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -189,9 +189,9 @@ MarketplaceApi.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -207,9 +207,9 @@ MarketplaceApi.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -219,69 +219,69 @@ MarketplaceApi.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -289,9 +289,9 @@ MarketplaceApi.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### url @@ -307,9 +307,9 @@ MarketplaceApi.url #### Defined in -[src/services/metadata/MarketplaceAPI.ts:12](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L12) +[src/services/metadata/MarketplaceAPI.ts:12](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L12) ---- +___ ### walletClient @@ -319,38 +319,38 @@ MarketplaceApi.url `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -358,7 +358,7 @@ MarketplaceApi.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -368,8 +368,8 @@ MarketplaceApi.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `clientAssertion` | `string` | #### Returns @@ -382,9 +382,9 @@ MarketplaceApi.walletClient #### Defined in -[src/services/metadata/MarketplaceAPI.ts:36](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L36) +[src/services/metadata/MarketplaceAPI.ts:36](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L36) ---- +___ ### create @@ -394,8 +394,8 @@ Create bookmark #### Parameters -| Name | Type | -| :------------ | :-------------------------------------------- | +| Name | Type | +| :------ | :------ | | `newBookmark` | [`NewBookmark`](../interfaces/NewBookmark.md) | #### Returns @@ -404,9 +404,9 @@ Create bookmark #### Defined in -[src/services/metadata/Bookmarks.ts:12](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/Bookmarks.ts#L12) +[src/services/metadata/Bookmarks.ts:12](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/Bookmarks.ts#L12) ---- +___ ### deleteOneById @@ -416,8 +416,8 @@ Delele a bookmark by id #### Parameters -| Name | Type | -| :--- | :------- | +| Name | Type | +| :------ | :------ | | `id` | `string` | #### Returns @@ -426,9 +426,9 @@ Delele a bookmark by id #### Defined in -[src/services/metadata/Bookmarks.ts:110](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/Bookmarks.ts#L110) +[src/services/metadata/Bookmarks.ts:110](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/Bookmarks.ts#L110) ---- +___ ### findManyByUserId @@ -438,9 +438,9 @@ Get bookmarks by userId #### Parameters -| Name | Type | -| :------- | :-------------------------------------------- | -| `userId` | `string` | +| Name | Type | +| :------ | :------ | +| `userId` | `string` | | `query?` | [`SearchQuery`](../interfaces/SearchQuery.md) | #### Returns @@ -449,9 +449,9 @@ Get bookmarks by userId #### Defined in -[src/services/metadata/Bookmarks.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/Bookmarks.ts#L61) +[src/services/metadata/Bookmarks.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/Bookmarks.ts#L61) ---- +___ ### findOneById @@ -461,8 +461,8 @@ Get a bookmark by Id #### Parameters -| Name | Type | -| :--- | :------- | +| Name | Type | +| :------ | :------ | | `id` | `string` | #### Returns @@ -471,9 +471,9 @@ Get a bookmark by Id #### Defined in -[src/services/metadata/Bookmarks.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/Bookmarks.ts#L39) +[src/services/metadata/Bookmarks.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/Bookmarks.ts#L39) ---- +___ ### login @@ -481,8 +481,8 @@ Get a bookmark by Id #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `clientAssertion` | `string` | #### Returns @@ -495,9 +495,9 @@ Get a bookmark by Id #### Defined in -[src/services/metadata/MarketplaceAPI.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L16) +[src/services/metadata/MarketplaceAPI.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L16) ---- +___ ### setInstanceConfig @@ -505,8 +505,8 @@ Get a bookmark by Id #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -519,9 +519,9 @@ Get a bookmark by Id #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### updateOneById @@ -531,9 +531,9 @@ Update a bookmark by id #### Parameters -| Name | Type | -| :--------- | :--------------------------------------------------- | -| `id` | `string` | +| Name | Type | +| :------ | :------ | +| `id` | `string` | | `bookmark` | `Partial`\<[`Bookmark`](../interfaces/Bookmark.md)\> | #### Returns @@ -542,9 +542,9 @@ Update a bookmark by id #### Defined in -[src/services/metadata/Bookmarks.ts:86](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/Bookmarks.ts#L86) +[src/services/metadata/Bookmarks.ts:86](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/Bookmarks.ts#L86) ---- +___ ### getInstance @@ -552,8 +552,8 @@ Update a bookmark by id #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -566,9 +566,9 @@ Update a bookmark by id #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -576,15 +576,15 @@ Update a bookmark by id #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -597,4 +597,4 @@ Update a bookmark by id #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/ClientError.md b/docs/nevermined-sdk/api-reference/classes/ClientError.md deleted file mode 100644 index dedd95abae..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/ClientError.md +++ /dev/null @@ -1,168 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / ClientError - -# Class: ClientError - -## Hierarchy - -- `Error` - - ↳ **`ClientError`** - -## Table of contents - -### Constructors - -- [constructor](ClientError.md#constructor) - -### Properties - -- [message](ClientError.md#message) -- [name](ClientError.md#name) -- [stack](ClientError.md#stack) -- [prepareStackTrace](ClientError.md#preparestacktrace) -- [stackTraceLimit](ClientError.md#stacktracelimit) - -### Methods - -- [captureStackTrace](ClientError.md#capturestacktrace) - -## Constructors - -### constructor - -• **new ClientError**(`message`, `clientName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `clientName` | `string` | - -#### Overrides - -Error.constructor - -#### Defined in - -[src/errors/ClientError.ts:2](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/errors/ClientError.ts#L2) - -## Properties - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1041 - -___ - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1040 - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1042 - -node_modules/@types/node/globals.d.ts:127 - -___ - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -**`See`** - -https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -##### Returns - -`any` - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/@types/node/globals.d.ts:140 - -___ - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/@types/node/globals.d.ts:142 - -## 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:133 diff --git a/docs/nevermined-sdk/api-reference/classes/ComputeApi.md b/docs/nevermined-sdk/api-reference/classes/ComputeApi.md index bc5fb1fb29..38620bfdf1 100644 --- a/docs/nevermined-sdk/api-reference/classes/ComputeApi.md +++ b/docs/nevermined-sdk/api-reference/classes/ComputeApi.md @@ -66,8 +66,8 @@ Creates a new ComputeApi #### Parameters -| Name | Type | Description | -| :------- | :---------------------------------------------------------- | :--------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Configuration of the Nevermined instance | #### Returns @@ -82,7 +82,7 @@ Creates a new ComputeApi #### Defined in -[src/nevermined/api/ComputeApi.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ComputeApi.ts#L29) +[src/nevermined/api/ComputeApi.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ComputeApi.ts#L29) ## Properties @@ -100,7 +100,7 @@ Creates a new ComputeApi #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L39) +[src/nevermined/api/RegistryBaseApi.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L39) ## Accessors @@ -118,9 +118,9 @@ RegistryBaseApi.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -136,9 +136,9 @@ RegistryBaseApi.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -154,9 +154,9 @@ RegistryBaseApi.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -172,9 +172,9 @@ RegistryBaseApi.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -190,9 +190,9 @@ RegistryBaseApi.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -208,9 +208,9 @@ RegistryBaseApi.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -226,9 +226,9 @@ RegistryBaseApi.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -244,9 +244,9 @@ RegistryBaseApi.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -256,69 +256,69 @@ RegistryBaseApi.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -326,9 +326,9 @@ RegistryBaseApi.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -338,38 +338,38 @@ RegistryBaseApi.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -377,7 +377,7 @@ RegistryBaseApi.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -389,14 +389,14 @@ Given a DID, it adds a vote to the asset curation information. #### Parameters -| Name | Type | Default value | Description | -| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `newRating` | `number` | `undefined` | New average rating of the asset | -| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `newRating` | `number` | `undefined` | New average rating of the asset | +| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -410,9 +410,9 @@ Given a DID, it adds a vote to the asset curation information. #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:534](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L534) +[src/nevermined/api/RegistryBaseApi.ts:534](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L534) ---- +___ ### create @@ -424,12 +424,12 @@ You can find more information about how different data is stored in Nevermined h #### Parameters -| Name | Type | Description | -| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | -| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | -| `publisherAccount` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | +| Name | Type | Description | +| :------ | :------ | :------ | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `publisherAccount` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | | `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -445,9 +445,9 @@ The metadata of the asset created (DDO) #### Defined in -[src/nevermined/api/ComputeApi.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ComputeApi.ts#L48) +[src/nevermined/api/ComputeApi.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ComputeApi.ts#L48) ---- +___ ### execute @@ -457,11 +457,11 @@ It triggers the execution of a compute job #### Parameters -| Name | Type | Description | -| :------------ | :---------------------------- | :----------------------------------------------------------- | -| `agreementId` | `string` | The unique identifier of the order placed for a service | -| `workflowDid` | `string` | The unique identifier of the Asset representing the workflow | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the user triggering the computation | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | The unique identifier of the order placed for a service | +| `workflowDid` | `string` | The unique identifier of the Asset representing the workflow | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the user triggering the computation | #### Returns @@ -471,9 +471,9 @@ If the execution is correct it returns the response given by the Nevermined Node #### Defined in -[src/nevermined/api/ComputeApi.ts:125](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ComputeApi.ts#L125) +[src/nevermined/api/ComputeApi.ts:125](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ComputeApi.ts#L125) ---- +___ ### list @@ -484,13 +484,13 @@ In a Nevermined environment, when an asset is unlisted, it is not possible to be #### Parameters -| Name | Type | Default value | Description | -| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -504,9 +504,9 @@ In a Nevermined environment, when an asset is unlisted, it is not possible to be #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:482](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L482) +[src/nevermined/api/RegistryBaseApi.ts:482](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L482) ---- +___ ### logs @@ -516,11 +516,11 @@ It returns the logs resulted by the execution of a Job #### Parameters -| Name | Type | Description | -| :------------ | :---------------------------- | :------------------------------------------------------ | -| `agreementId` | `string` | The unique identifier of the order placed for a service | -| `executionId` | `string` | The unique identifier of the job executed | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the user triggering the computation | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | The unique identifier of the order placed for a service | +| `executionId` | `string` | The unique identifier of the job executed | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the user triggering the computation | #### Returns @@ -530,9 +530,9 @@ The logs resulted of the execution of the job #### Defined in -[src/nevermined/api/ComputeApi.ts:142](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ComputeApi.ts#L142) +[src/nevermined/api/ComputeApi.ts:142](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ComputeApi.ts#L142) ---- +___ ### order @@ -543,11 +543,11 @@ then sends the request to the publisher via the service endpoint (Node http serv #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :----------------------------------------- | -| `did` | `string` | Unique identifier of the asset to order | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the user ordering the asset | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | Unique identifier of the asset to order | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the user ordering the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -557,9 +557,9 @@ The agreement ID identifying the order #### Defined in -[src/nevermined/api/ComputeApi.ts:110](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ComputeApi.ts#L110) +[src/nevermined/api/ComputeApi.ts:110](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ComputeApi.ts#L110) ---- +___ ### orderAsset @@ -570,12 +570,12 @@ then sends the request to the publisher via the service endpoint (Node http serv #### Parameters -| Name | Type | Description | -| :----------------- | :------------------------------------------------------------ | :--------------------- | -| `did` | `string` | Decentralized ID. | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | -| `from` | [`NvmAccount`](NvmAccount.md) | Consumer account. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | Decentralized ID. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `from` | [`NvmAccount`](NvmAccount.md) | Consumer account. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -589,9 +589,9 @@ The agreement ID. #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:585](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L585) +[src/nevermined/api/RegistryBaseApi.ts:585](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L585) ---- +___ ### registerNeverminedAsset @@ -602,13 +602,13 @@ via the Nevermined APIs directly. It must accessed via the `assets`, `compute`, #### Parameters -| Name | Type | Description | -| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | -| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | +| Name | Type | Description | +| :------ | :------ | :------ | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | | `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -626,9 +626,9 @@ The metadata of the asset created (DDO) #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L52) +[src/nevermined/api/RegistryBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L52) ---- +___ ### resolveAsset @@ -639,9 +639,9 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Parameters -| Name | Type | Default value | Description | -| :------- | :------------------------------------------------- | :---------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID. | | `policy` | [`DIDResolvePolicy`](../enums/DIDResolvePolicy.md) | `DIDResolvePolicy.MetadataAPIFirst` | It specifies the resolve policy to apply. It allows to select that priorities during the asset resolution via Metadata API or Immutable URLs (IPFS, Filecoin, etc) | #### Returns @@ -656,9 +656,9 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:324](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L324) +[src/nevermined/api/RegistryBaseApi.ts:324](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L324) ---- +___ ### setInstanceConfig @@ -666,8 +666,8 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -680,9 +680,9 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### status @@ -692,11 +692,11 @@ It returns the status of a compute job #### Parameters -| Name | Type | Description | -| :------------ | :---------------------------- | :------------------------------------------------------ | -| `agreementId` | `string` | The unique identifier of the order placed for a service | -| `executionId` | `string` | The unique identifier of the job executed | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the user triggering the computation | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | The unique identifier of the order placed for a service | +| `executionId` | `string` | The unique identifier of the job executed | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the user triggering the computation | #### Returns @@ -706,9 +706,9 @@ The status of the job #### Defined in -[src/nevermined/api/ComputeApi.ts:153](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ComputeApi.ts#L153) +[src/nevermined/api/ComputeApi.ts:153](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ComputeApi.ts#L153) ---- +___ ### update @@ -718,13 +718,13 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Parameters -| Name | Type | Default value | Description | -| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -736,18 +736,18 @@ Given a DID, updates the metadata associated to the asset. It also can upload th ```ts const ddoUpdated = await nevermined.compute.update( - ddo.shortId(), - updatedMetadata, - publisher, - PublishMetadata.IPFS, + ddo.shortId(), + updatedMetadata, + publisher, + PublishMetadata.IPFS ) ``` #### Defined in -[src/nevermined/api/ComputeApi.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ComputeApi.ts#L92) +[src/nevermined/api/ComputeApi.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ComputeApi.ts#L92) ---- +___ ### updateAsset @@ -757,13 +757,13 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Parameters -| Name | Type | Default value | Description | -| :----------------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -777,9 +777,9 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:367](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L367) +[src/nevermined/api/RegistryBaseApi.ts:367](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L367) ---- +___ ### getInstance @@ -787,8 +787,8 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -801,9 +801,9 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### getServicePlugin @@ -813,8 +813,8 @@ Initializes the default Nevermined service plugins and return that instance #### Parameters -| Name | Type | Description | -| :------- | :---------------------------------------------------------- | :---------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Nevermined config | #### Returns @@ -823,12 +823,12 @@ Initializes the default Nevermined service plugins and return that instance The Nevermined Service Plugin instance -| Name | Type | -| :----------- | :-------------------------------------------------------------------- | -| `access` | [`AccessService`](AccessService.md) | -| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | -| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | -| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | +| Name | Type | +| :------ | :------ | +| `access` | [`AccessService`](AccessService.md) | +| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | +| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | +| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | #### Inherited from @@ -836,9 +836,9 @@ The Nevermined Service Plugin instance #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:640](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L640) +[src/nevermined/api/RegistryBaseApi.ts:640](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L640) ---- +___ ### setInstanceConfig @@ -846,15 +846,15 @@ The Nevermined Service Plugin instance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -867,4 +867,4 @@ The Nevermined Service Plugin instance #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/ComputeExecutionCondition.md b/docs/nevermined-sdk/api-reference/classes/ComputeExecutionCondition.md index 5143f4aadb..9837e8863e 100644 --- a/docs/nevermined-sdk/api-reference/classes/ComputeExecutionCondition.md +++ b/docs/nevermined-sdk/api-reference/classes/ComputeExecutionCondition.md @@ -73,8 +73,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -87,7 +87,7 @@ ProviderCondition\.constructor #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -101,9 +101,9 @@ ProviderCondition.address #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -115,9 +115,9 @@ ProviderCondition.contract #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -129,9 +129,9 @@ ProviderCondition.contractName #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -143,9 +143,9 @@ ProviderCondition.events #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -157,7 +157,7 @@ ProviderCondition.version #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -175,9 +175,9 @@ ProviderCondition.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -193,9 +193,9 @@ ProviderCondition.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -211,9 +211,9 @@ ProviderCondition.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -229,9 +229,9 @@ ProviderCondition.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -247,9 +247,9 @@ ProviderCondition.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -265,9 +265,9 @@ ProviderCondition.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -283,9 +283,9 @@ ProviderCondition.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -301,9 +301,9 @@ ProviderCondition.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -313,69 +313,69 @@ ProviderCondition.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -383,9 +383,9 @@ ProviderCondition.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -395,38 +395,38 @@ ProviderCondition.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -434,7 +434,7 @@ ProviderCondition.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -444,11 +444,11 @@ ProviderCondition.walletClient #### Parameters -| Name | Type | -| :------------ | :---------------------------------------------- | -| `conditionId` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `conditionId` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -460,9 +460,9 @@ ProviderCondition.abortByTimeOut #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L75) +[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L75) ---- +___ ### call @@ -471,16 +471,16 @@ ProviderCondition.abortByTimeOut #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -492,9 +492,9 @@ ProviderCondition.call #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### fulfill @@ -502,13 +502,13 @@ ProviderCondition.call #### Parameters -| Name | Type | -| :---------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `computeConsumer` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `computeConsumer` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -520,9 +520,9 @@ ProviderCondition.fulfill #### Defined in -[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:28](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L28) +[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:28](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L28) ---- +___ ### fulfillInstance @@ -530,13 +530,13 @@ ProviderCondition.fulfill #### Parameters -| Name | Type | Default value | -| :----------------- | :-------------------------------------------------------- | :------------ | -| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -548,9 +548,9 @@ ProviderCondition.fulfillInstance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L139) +[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L139) ---- +___ ### fulfillPlain @@ -558,13 +558,13 @@ ProviderCondition.fulfillInstance #### Parameters -| Name | Type | Default value | -| :------------ | :-------------------------------------------------------- | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -576,9 +576,9 @@ ProviderCondition.fulfillPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L47) +[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L47) ---- +___ ### fulfillWithNode @@ -586,12 +586,12 @@ ProviderCondition.fulfillPlain #### Parameters -| Name | Type | -| :----------------- | :----------------------------------------------------- | -| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | -| `additionalParams` | `Record`\<`string`, `unknown`\> | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | +| `additionalParams` | `Record`\<`string`, `unknown`\> | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -603,9 +603,9 @@ ProviderCondition.fulfillWithNode #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L183) +[src/keeper/contracts/conditions/Condition.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L183) ---- +___ ### generateId @@ -613,10 +613,10 @@ ProviderCondition.fulfillWithNode #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -628,9 +628,9 @@ ProviderCondition.generateId #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L61) +[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L61) ---- +___ ### generateIdHash @@ -638,10 +638,10 @@ ProviderCondition.generateId #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `...values` | `any`[] | +| `...values` | `any`[] | #### Returns @@ -653,9 +653,9 @@ ProviderCondition.generateIdHash #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L57) +[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L57) ---- +___ ### generateIdWithSeed @@ -663,10 +663,10 @@ ProviderCondition.generateIdHash #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -678,9 +678,9 @@ ProviderCondition.generateIdWithSeed #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L65) +[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L65) ---- +___ ### getConditionFulfilledEvent @@ -688,8 +688,8 @@ ProviderCondition.generateIdWithSeed #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns @@ -702,9 +702,9 @@ ProviderCondition.getConditionFulfilledEvent #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L79) +[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L79) ---- +___ ### getFromAddress @@ -712,8 +712,8 @@ ProviderCondition.getConditionFulfilledEvent #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -726,24 +726,24 @@ ProviderCondition.getFromAddress #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -751,9 +751,9 @@ ProviderCondition.getTransactionLogs #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### hashValues @@ -761,8 +761,8 @@ ProviderCondition.getTransactionLogs #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -775,9 +775,9 @@ ProviderCondition.hashValues #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L116) +[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L116) ---- +___ ### hashValuesPlain @@ -785,8 +785,8 @@ ProviderCondition.hashValues #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -799,9 +799,9 @@ ProviderCondition.hashValuesPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L122) +[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L122) ---- +___ ### init @@ -809,11 +809,11 @@ ProviderCondition.hashValuesPlain #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -825,9 +825,9 @@ ProviderCondition.init #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instance @@ -835,10 +835,10 @@ ProviderCondition.init #### Parameters -| Name | Type | -| :------------ | :------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | #### Returns @@ -850,9 +850,9 @@ ProviderCondition.instance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L163) +[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L163) ---- +___ ### instanceFromDDO @@ -860,11 +860,11 @@ ProviderCondition.instance #### Parameters -| Name | Type | -| :------------ | :-------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `ComputeExecutionConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `ctx` | `ComputeExecutionConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | #### Returns @@ -876,9 +876,9 @@ ProviderCondition.instanceFromDDO #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L131) +[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L131) ---- +___ ### nodeMethod @@ -894,9 +894,9 @@ ProviderCondition.nodeMethod #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L200) +[src/keeper/contracts/conditions/Condition.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L200) ---- +___ ### params @@ -904,9 +904,9 @@ ProviderCondition.nodeMethod #### Parameters -| Name | Type | -| :---------------- | :------- | -| `did` | `string` | +| Name | Type | +| :------ | :------ | +| `did` | `string` | | `computeConsumer` | `string` | #### Returns @@ -919,9 +919,9 @@ ProviderCondition.params #### Defined in -[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L24) +[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L24) ---- +___ ### paramsFromDDO @@ -929,8 +929,8 @@ ProviderCondition.params #### Parameters -| Name | Type | -| :--------------- | :--------------------------------- | +| Name | Type | +| :------ | :------ | | `«destructured»` | `ComputeExecutionConditionContext` | #### Returns @@ -943,9 +943,9 @@ ProviderCondition.paramsFromDDO #### Defined in -[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L16) +[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L16) ---- +___ ### send @@ -953,12 +953,12 @@ ProviderCondition.paramsFromDDO #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -970,9 +970,9 @@ ProviderCondition.send #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -980,12 +980,12 @@ ProviderCondition.send #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -997,9 +997,9 @@ ProviderCondition.sendFrom #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -1007,8 +1007,8 @@ ProviderCondition.sendFrom #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1021,9 +1021,9 @@ ProviderCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1031,8 +1031,8 @@ ProviderCondition.setInstanceConfig #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1045,9 +1045,9 @@ ProviderCondition.someLog #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### wasComputeTriggered @@ -1055,11 +1055,11 @@ ProviderCondition.someLog #### Parameters -| Name | Type | -| :---------------- | :---------------------------- | -| `did` | `string` | -| `computeConsumer` | `string` | -| `from?` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `computeConsumer` | `string` | +| `from?` | [`NvmAccount`](NvmAccount.md) | #### Returns @@ -1067,9 +1067,9 @@ ProviderCondition.someLog #### Defined in -[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:43](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L43) +[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:43](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L43) ---- +___ ### getInstance @@ -1077,8 +1077,8 @@ ProviderCondition.someLog #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1091,9 +1091,9 @@ ProviderCondition.getInstance #### Defined in -[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L20) +[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L20) ---- +___ ### setInstanceConfig @@ -1101,15 +1101,15 @@ ProviderCondition.getInstance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1122,4 +1122,4 @@ ProviderCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/Condition.md b/docs/nevermined-sdk/api-reference/classes/Condition.md deleted file mode 100644 index 1a3f243167..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/Condition.md +++ /dev/null @@ -1,1089 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / Condition - -# Class: Condition - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Record`<`string`, `unknown`\> | - -## Hierarchy - -- [`ConditionSmall`](conditions.ConditionSmall.md) - - ↳ **`Condition`** - - ↳↳ [`ProviderCondition`](conditions.ProviderCondition.md) - - ↳↳ [`ConsumerCondition`](conditions.ConsumerCondition.md) - -## Table of contents - -### Constructors - -- [constructor](Condition.md#constructor) - -### Properties - -- [contract](Condition.md#contract) -- [contractName](Condition.md#contractname) -- [events](Condition.md#events) -- [version](Condition.md#version) - -### Accessors - -- [address](Condition.md#address) -- [artifactsFolder](Condition.md#artifactsfolder) -- [config](Condition.md#config) -- [instanceConfig](Condition.md#instanceconfig) -- [instantiableConfig](Condition.md#instantiableconfig) -- [logger](Condition.md#logger) -- [nevermined](Condition.md#nevermined) -- [web3](Condition.md#web3) - -### Methods - -- [abortByTimeOut](Condition.md#abortbytimeout) -- [addresses](Condition.md#addresses) -- [call](Condition.md#call) -- [checkExists](Condition.md#checkexists) -- [findSigner](Condition.md#findsigner) -- [fulfill](Condition.md#fulfill) -- [fulfillGateway](Condition.md#fulfillgateway) -- [fulfillInstance](Condition.md#fulfillinstance) -- [fulfillPlain](Condition.md#fulfillplain) -- [generateId](Condition.md#generateid) -- [generateIdHash](Condition.md#generateidhash) -- [generateIdWithSeed](Condition.md#generateidwithseed) -- [getAddress](Condition.md#getaddress) -- [getConditionFulfilledEvent](Condition.md#getconditionfulfilledevent) -- [getContract](Condition.md#getcontract) -- [getFromAddress](Condition.md#getfromaddress) -- [getInputsOfMethod](Condition.md#getinputsofmethod) -- [getSignatureOfMethod](Condition.md#getsignatureofmethod) -- [hashValues](Condition.md#hashvalues) -- [hashValuesPlain](Condition.md#hashvaluesplain) -- [init](Condition.md#init) -- [instance](Condition.md#instance) -- [instanceFromDDO](Condition.md#instancefromddo) -- [params](Condition.md#params) -- [paramsFromDDO](Condition.md#paramsfromddo) -- [send](Condition.md#send) -- [sendFrom](Condition.md#sendfrom) -- [setInstanceConfig](Condition.md#setinstanceconfig) -- [addressesStatic](Condition.md#addressesstatic) -- [findSignerStatic](Condition.md#findsignerstatic) -- [getInstance](Condition.md#getinstance) -- [setInstanceConfig](Condition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new Condition**<`Ctx`, `Extra`\>(`contractName`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Record`<`string`, `unknown`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[constructor](conditions.ConditionSmall.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[contract](conditions.ConditionSmall.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[contractName](conditions.ConditionSmall.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[events](conditions.ConditionSmall.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[version](conditions.ConditionSmall.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ConditionSmall.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ConditionSmall.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ConditionSmall.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ConditionSmall.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ConditionSmall.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ConditionSmall.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ConditionSmall.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ConditionSmall.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[abortByTimeOut](conditions.ConditionSmall.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[addresses](conditions.ConditionSmall.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[call](conditions.ConditionSmall.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[checkExists](conditions.ConditionSmall.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[findSigner](conditions.ConditionSmall.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ `Abstract` **fulfill**(`agreementId`, ...`args`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...args` | `any`[] | - -#### Returns - -`any` - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[fulfill](conditions.ConditionSmall.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:67](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L67) - -___ - -### fulfillGateway - -▸ `Abstract` **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`void` \| `ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\> | -| `additionalParams` | `Extra` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`void` \| `ContractReceipt`\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:177](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L177) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\> | `undefined` | -| `additionalParams` | `Extra` | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[fulfillPlain](conditions.ConditionSmall.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[generateId](conditions.ConditionSmall.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[generateIdHash](conditions.ConditionSmall.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[generateIdWithSeed](conditions.ConditionSmall.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[getAddress](conditions.ConditionSmall.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[getConditionFulfilledEvent](conditions.ConditionSmall.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[getContract](conditions.ConditionSmall.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[getFromAddress](conditions.ConditionSmall.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[getInputsOfMethod](conditions.ConditionSmall.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[getSignatureOfMethod](conditions.ConditionSmall.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Overrides - -[ConditionSmall](conditions.ConditionSmall.md).[hashValues](conditions.ConditionSmall.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[init](conditions.ConditionSmall.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | `Ctx` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### params - -▸ **params**(...`args`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:134](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L134) - -___ - -### paramsFromDDO - -▸ `Abstract` **paramsFromDDO**(`ctx`, ...`args`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ctx` | `Ctx` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\>\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L149) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[send](conditions.ConditionSmall.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[sendFrom](conditions.ConditionSmall.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[setInstanceConfig](conditions.ConditionSmall.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[addressesStatic](conditions.ConditionSmall.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[findSignerStatic](conditions.ConditionSmall.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**<`Ctx`, `Extra`\>(`config`, `conditionName`, `conditionsClass`, `optional?`): `Promise`<`any`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Extra` | - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `conditionName` | `string` | `undefined` | -| `conditionsClass` | `any` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`any`\> - -#### Overrides - -[ConditionSmall](conditions.ConditionSmall.md).[getInstance](conditions.ConditionSmall.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:121](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L121) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[setInstanceConfig](conditions.ConditionSmall.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/ConditionStoreManager.md b/docs/nevermined-sdk/api-reference/classes/ConditionStoreManager.md index 3e9add154f..52f7f8cbdc 100644 --- a/docs/nevermined-sdk/api-reference/classes/ConditionStoreManager.md +++ b/docs/nevermined-sdk/api-reference/classes/ConditionStoreManager.md @@ -63,8 +63,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -77,7 +77,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -91,9 +91,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -105,9 +105,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -119,9 +119,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -133,9 +133,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -147,7 +147,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -165,9 +165,9 @@ ContractBase.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -183,9 +183,9 @@ ContractBase.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -201,9 +201,9 @@ ContractBase.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -219,9 +219,9 @@ ContractBase.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -237,9 +237,9 @@ ContractBase.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -255,9 +255,9 @@ ContractBase.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -273,9 +273,9 @@ ContractBase.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -291,9 +291,9 @@ ContractBase.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -303,69 +303,69 @@ ContractBase.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -373,9 +373,9 @@ ContractBase.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -385,38 +385,38 @@ ContractBase.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -424,7 +424,7 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -435,16 +435,16 @@ ContractBase.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -456,9 +456,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### createCondition @@ -466,11 +466,11 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :---------- | :---------------------------------------------- | -| `id` | `string` | -| `typeRef` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `typeRef` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | | `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -479,9 +479,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/ConditionStoreManager.ts:27](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/ConditionStoreManager.ts#L27) +[src/keeper/contracts/managers/ConditionStoreManager.ts:27](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/ConditionStoreManager.ts#L27) ---- +___ ### delegateCreateRole @@ -489,10 +489,10 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :---------- | :---------------------------------------------- | -| `delegatee` | `string` | -| `owner` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `delegatee` | `string` | +| `owner` | [`NvmAccount`](NvmAccount.md) | | `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -501,9 +501,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/ConditionStoreManager.ts:36](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/ConditionStoreManager.ts#L36) +[src/keeper/contracts/managers/ConditionStoreManager.ts:36](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/ConditionStoreManager.ts#L36) ---- +___ ### getCondition @@ -511,8 +511,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `conditionId` | `string` | #### Returns @@ -521,9 +521,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/ConditionStoreManager.ts:56](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/ConditionStoreManager.ts#L56) +[src/keeper/contracts/managers/ConditionStoreManager.ts:56](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/ConditionStoreManager.ts#L56) ---- +___ ### getCreateRole @@ -535,9 +535,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/ConditionStoreManager.ts:40](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/ConditionStoreManager.ts#L40) +[src/keeper/contracts/managers/ConditionStoreManager.ts:40](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/ConditionStoreManager.ts#L40) ---- +___ ### getFromAddress @@ -545,8 +545,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -559,9 +559,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getOwner @@ -573,24 +573,24 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/ConditionStoreManager.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/ConditionStoreManager.ts#L52) +[src/keeper/contracts/managers/ConditionStoreManager.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/ConditionStoreManager.ts#L52) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -598,9 +598,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -608,11 +608,11 @@ ContractBase.walletClient #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -624,9 +624,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### isConditionTimeLocked @@ -634,8 +634,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :--- | :------- | +| Name | Type | +| :------ | :------ | | `id` | `string` | #### Returns @@ -644,9 +644,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/ConditionStoreManager.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/ConditionStoreManager.ts#L44) +[src/keeper/contracts/managers/ConditionStoreManager.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/ConditionStoreManager.ts#L44) ---- +___ ### isConditionTimedOut @@ -654,8 +654,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :--- | :------- | +| Name | Type | +| :------ | :------ | | `id` | `string` | #### Returns @@ -664,9 +664,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/ConditionStoreManager.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/ConditionStoreManager.ts#L48) +[src/keeper/contracts/managers/ConditionStoreManager.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/ConditionStoreManager.ts#L48) ---- +___ ### send @@ -674,12 +674,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -691,9 +691,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -701,12 +701,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -718,9 +718,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -728,8 +728,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -742,9 +742,9 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -752,8 +752,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -766,9 +766,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -776,8 +776,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -790,9 +790,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/ConditionStoreManager.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/ConditionStoreManager.ts#L19) +[src/keeper/contracts/managers/ConditionStoreManager.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/ConditionStoreManager.ts#L19) ---- +___ ### setInstanceConfig @@ -800,15 +800,15 @@ ContractBase.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -821,4 +821,4 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/Config.md b/docs/nevermined-sdk/api-reference/classes/Config.md deleted file mode 100644 index df99704747..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/Config.md +++ /dev/null @@ -1,258 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / Config - -# Class: Config - -## Table of contents - -### Constructors - -- [constructor](Config.md#constructor) - -### Properties - -- [aaveConfig](Config.md#aaveconfig) -- [accounts](Config.md#accounts) -- [artifactsFolder](Config.md#artifactsfolder) -- [authMessage](Config.md#authmessage) -- [authTokenExpiration](Config.md#authtokenexpiration) -- [faucetUri](Config.md#fauceturi) -- [feeReceiver](Config.md#feereceiver) -- [gasMultiplier](Config.md#gasmultiplier) -- [nodeAddress](Config.md#nodeAddress) -- [neverminedNodeUri](Config.md#neverminedNodeUri) -- [graphHttpUri](Config.md#graphhttpuri) -- [marketplaceAuthToken](Config.md#marketplaceauthtoken) -- [marketplaceUri](Config.md#marketplaceuri) -- [networkFee](Config.md#networkfee) -- [newGateway](Config.md#newgateway) -- [nodeUri](Config.md#nodeuri) -- [threshold](Config.md#threshold) -- [verbose](Config.md#verbose) -- [web3Provider](Config.md#web3provider) - -## Constructors - -### constructor - -• **new Config**() - -## Properties - -### aaveConfig - -• `Optional` **aaveConfig**: `AaveConfig` - -#### Defined in - -[src/models/Config.ts:71](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L71) - -___ - -### accounts - -• `Optional` **accounts**: `Signer`[] - -#### Defined in - -[src/models/Config.ts:78](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L78) - -___ - -### artifactsFolder - -• `Optional` **artifactsFolder**: `string` - -The folder where the nevermined contract artifacts are located. - -#### Defined in - -[src/models/Config.ts:76](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L76) - -___ - -### authMessage - -• `Optional` **authMessage**: `string` - -Message shown when the user creates its own token. - -#### Defined in - -[src/models/Config.ts:51](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L51) - -___ - -### authTokenExpiration - -• `Optional` **authTokenExpiration**: `number` - -Token expiration time in ms. - -#### Defined in - -[src/models/Config.ts:56](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L56) - -___ - -### faucetUri - -• `Optional` **faucetUri**: `string` - -Faucet URL. - -#### Defined in - -[src/models/Config.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L26) - -___ - -### feeReceiver - -• `Optional` **feeReceiver**: `string` = `ZeroAddress` - -The address receiving the fee if this is higher than 0 - -#### Defined in - -[src/models/Config.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L90) - -___ - -### gasMultiplier - -• `Optional` **gasMultiplier**: `number` - -Gas multiplier for the fees. -Can be used to speed up the transactions. - -#### Defined in - -[src/models/Config.ts:64](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L64) - -___ - -### nodeAddress - -• `Optional` **nodeAddress**: `string` - -Address of Gateway. - -#### Defined in - -[src/models/Config.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L31) - -___ - -### neverminedNodeUri - -• **neverminedNodeUri**: `string` - -Node URL. - -#### Defined in - -[src/models/Config.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L21) - -___ - -### graphHttpUri - -• `Optional` **graphHttpUri**: `string` - -Enpoint for the graph-node http query - -#### Defined in - -[src/models/Config.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L69) - -___ - -### marketplaceAuthToken - -• `Optional` **marketplaceAuthToken**: `string` - -Marketplace auth token. - -#### Defined in - -[src/models/Config.ts:16](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L16) - -___ - -### marketplaceUri - -• **marketplaceUri**: `string` - -MarketPlace URL. - -#### Defined in - -[src/models/Config.ts:11](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L11) - -___ - -### networkFee - -• `Optional` **networkFee**: `number` = `0` - -The fee charged by Nevermined for using the Service Agreements - -#### Defined in - -[src/models/Config.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L85) - -___ - -### newGateway - -• `Optional` **newGateway**: `boolean` = `true` - -#### Defined in - -[src/models/Config.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L80) - -___ - -### nodeUri - -• `Optional` **nodeUri**: `string` - -Ethereum node URL. - -#### Defined in - -[src/models/Config.ts:36](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L36) - -___ - -### threshold - -• `Optional` **threshold**: `number` - -#### Defined in - -[src/models/Config.ts:58](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L58) - -___ - -### verbose - -• `Optional` **verbose**: `boolean` \| [`LogLevel`](../enums/utils.LogLevel.md) - -Log level. - -#### Defined in - -[src/models/Config.ts:46](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L46) - -___ - -### web3Provider - -• `Optional` **web3Provider**: `any` - -Web3 Provider. - -#### Defined in - -[src/models/Config.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L41) diff --git a/docs/nevermined-sdk/api-reference/classes/ContractBase.md b/docs/nevermined-sdk/api-reference/classes/ContractBase.md index 5cfab8b9a5..bc29e4c458 100644 --- a/docs/nevermined-sdk/api-reference/classes/ContractBase.md +++ b/docs/nevermined-sdk/api-reference/classes/ContractBase.md @@ -81,8 +81,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -95,7 +95,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -105,9 +105,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -115,9 +115,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -125,9 +125,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -135,9 +135,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -145,7 +145,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -163,9 +163,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -181,9 +181,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -199,9 +199,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -217,9 +217,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -235,9 +235,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -253,9 +253,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -271,9 +271,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -289,9 +289,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -301,69 +301,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -371,9 +371,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -383,38 +383,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -422,7 +422,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -433,16 +433,16 @@ Instantiable.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -450,9 +450,9 @@ Instantiable.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### getFromAddress @@ -460,8 +460,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -470,30 +470,30 @@ Instantiable.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -501,11 +501,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -513,33 +513,33 @@ Instantiable.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### internalSendSessionKey -▸ **internalSendSessionKey**(`name`, `from`, `args`, `txparams`, `progress`): `Promise`\<\{ `actualGasCost`: `bigint` ; `actualGasUsed`: `bigint` ; `entryPoint`: \`0x$\{string}\` ; `logs`: \{ `address`: \`0x$\{string}\` ; `blockHash`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `data`: \`0x$\{string}\` ; `logIndex`: `bigint` ; `topics`: \`0x$\{string}\`[] ; `transactionHash`: \`0x$\{string}\` ; `transactionIndex`: `bigint` }[] ; `nonce`: `bigint` ; `paymaster?`: \`0x$\{string}\` ; `reason?`: `string` ; `receipt`: \{ `blockHash`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `contractAddress`: `null` \| \`0x$\{string}\` ; `cumulativeGasUsed`: `bigint` ; `effectiveGasPrice`: `bigint` ; `from`: \`0x$\{string}\` ; `gasUsed`: `bigint` ; `logsBloom`: \`0x$\{string}\` ; `status`: `TStatus` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionHash`: \`0x$\{string}\` ; `transactionIndex`: `bigint` } ; `sender`: \`0x$\{string}\` ; `success`: `boolean` ; `userOpHash`: \`0x$\{string}\` }\> +▸ **internalSendSessionKey**(`name`, `from`, `args`, `txparams`, `progress`): `Promise`\<\{ `actualGasCost`: `bigint` ; `actualGasUsed`: `bigint` ; `entryPoint`: \`0x$\{string}\` ; `logs`: \{ `address`: \`0x$\{string}\` ; `blockHash`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `data`: \`0x$\{string}\` ; `logIndex`: `bigint` ; `topics`: \`0x$\{string}\`[] ; `transactionHash`: \`0x$\{string}\` ; `transactionIndex`: `bigint` }[] ; `nonce`: `bigint` ; `paymaster?`: \`0x$\{string}\` ; `reason?`: `string` ; `receipt`: \{ `blockHash`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `contractAddress`: ``null`` \| \`0x$\{string}\` ; `cumulativeGasUsed`: `bigint` ; `effectiveGasPrice`: `bigint` ; `from`: \`0x$\{string}\` ; `gasUsed`: `bigint` ; `logsBloom`: \`0x$\{string}\` ; `status`: `TStatus` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionHash`: \`0x$\{string}\` ; `transactionIndex`: `bigint` } ; `sender`: \`0x$\{string}\` ; `success`: `boolean` ; `userOpHash`: \`0x$\{string}\` }\> #### Parameters -| Name | Type | -| :--------- | :--------------------------------------- | -| `name` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `txparams` | `any` | +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `txparams` | `any` | | `progress` | `undefined` \| (`data`: `any`) => `void` | #### Returns -`Promise`\<\{ `actualGasCost`: `bigint` ; `actualGasUsed`: `bigint` ; `entryPoint`: \`0x$\{string}\` ; `logs`: \{ `address`: \`0x$\{string}\` ; `blockHash`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `data`: \`0x$\{string}\` ; `logIndex`: `bigint` ; `topics`: \`0x$\{string}\`[] ; `transactionHash`: \`0x$\{string}\` ; `transactionIndex`: `bigint` }[] ; `nonce`: `bigint` ; `paymaster?`: \`0x$\{string}\` ; `reason?`: `string` ; `receipt`: \{ `blockHash`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `contractAddress`: `null` \| \`0x$\{string}\` ; `cumulativeGasUsed`: `bigint` ; `effectiveGasPrice`: `bigint` ; `from`: \`0x$\{string}\` ; `gasUsed`: `bigint` ; `logsBloom`: \`0x$\{string}\` ; `status`: `TStatus` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionHash`: \`0x$\{string}\` ; `transactionIndex`: `bigint` } ; `sender`: \`0x$\{string}\` ; `success`: `boolean` ; `userOpHash`: \`0x$\{string}\` }\> +`Promise`\<\{ `actualGasCost`: `bigint` ; `actualGasUsed`: `bigint` ; `entryPoint`: \`0x$\{string}\` ; `logs`: \{ `address`: \`0x$\{string}\` ; `blockHash`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `data`: \`0x$\{string}\` ; `logIndex`: `bigint` ; `topics`: \`0x$\{string}\`[] ; `transactionHash`: \`0x$\{string}\` ; `transactionIndex`: `bigint` }[] ; `nonce`: `bigint` ; `paymaster?`: \`0x$\{string}\` ; `reason?`: `string` ; `receipt`: \{ `blockHash`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `contractAddress`: ``null`` \| \`0x$\{string}\` ; `cumulativeGasUsed`: `bigint` ; `effectiveGasPrice`: `bigint` ; `from`: \`0x$\{string}\` ; `gasUsed`: `bigint` ; `logsBloom`: \`0x$\{string}\` ; `status`: `TStatus` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionHash`: \`0x$\{string}\` ; `transactionIndex`: `bigint` } ; `sender`: \`0x$\{string}\` ; `success`: `boolean` ; `userOpHash`: \`0x$\{string}\` }\> #### Defined in -[src/keeper/contracts/ContractBase.ts:165](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L165) +[src/keeper/contracts/ContractBase.ts:165](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L165) ---- +___ ### internalSendZeroDev @@ -547,12 +547,12 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------- | :--------------------------------------- | -| `name` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `txparams` | `any` | +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `txparams` | `any` | | `progress` | `undefined` \| (`data`: `any`) => `void` | #### Returns @@ -561,9 +561,9 @@ Instantiable.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:237](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L237) +[src/keeper/contracts/ContractBase.ts:237](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L237) ---- +___ ### localAccountSend @@ -571,12 +571,12 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------- | :--------------------------------------- | -| `name` | `string` | -| `from` | \`0x$\{string}\` \| `Account` | -| `args` | `any`[] | -| `txparams` | `any` | +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `from` | \`0x$\{string}\` \| `Account` | +| `args` | `any`[] | +| `txparams` | `any` | | `progress` | `undefined` \| (`data`: `any`) => `void` | #### Returns @@ -585,9 +585,9 @@ Instantiable.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:302](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L302) +[src/keeper/contracts/ContractBase.ts:302](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L302) ---- +___ ### send @@ -595,12 +595,12 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -608,9 +608,9 @@ Instantiable.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -618,12 +618,12 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -631,9 +631,9 @@ Instantiable.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -641,8 +641,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -655,9 +655,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -665,8 +665,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -675,9 +675,9 @@ Instantiable.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -685,8 +685,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -699,9 +699,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -709,15 +709,15 @@ Instantiable.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -730,4 +730,4 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/ContractEvent.md b/docs/nevermined-sdk/api-reference/classes/ContractEvent.md index 7a0ee4d55f..d1400878f4 100644 --- a/docs/nevermined-sdk/api-reference/classes/ContractEvent.md +++ b/docs/nevermined-sdk/api-reference/classes/ContractEvent.md @@ -57,9 +57,9 @@ Initializes the NeverminedEvent instance #### Parameters -| Name | Type | Description | -| :------------- | :---------------------------------------------- | :---------------------------- | -| `contract` | [`ContractBase`](ContractBase.md) | contract instance | +| Name | Type | Description | +| :------ | :------ | :------ | +| `contract` | [`ContractBase`](ContractBase.md) | contract instance | | `eventEmitter` | [`EventEmitter`](../interfaces/EventEmitter.md) | events emitter implementation | #### Returns @@ -74,7 +74,7 @@ the NeverminedEvent instance #### Defined in -[src/events/NeverminedEvent.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/NeverminedEvent.ts#L26) +[src/events/NeverminedEvent.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/NeverminedEvent.ts#L26) ## Properties @@ -88,9 +88,9 @@ the NeverminedEvent instance #### Defined in -[src/events/NeverminedEvent.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/NeverminedEvent.ts#L15) +[src/events/NeverminedEvent.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/NeverminedEvent.ts#L15) ---- +___ ### eventEmitter @@ -102,7 +102,7 @@ the NeverminedEvent instance #### Defined in -[src/events/NeverminedEvent.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/NeverminedEvent.ts#L14) +[src/events/NeverminedEvent.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/NeverminedEvent.ts#L14) ## Accessors @@ -120,9 +120,9 @@ NeverminedEvent.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -138,9 +138,9 @@ NeverminedEvent.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -156,9 +156,9 @@ NeverminedEvent.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -174,9 +174,9 @@ NeverminedEvent.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -192,9 +192,9 @@ NeverminedEvent.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -210,9 +210,9 @@ NeverminedEvent.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -228,9 +228,9 @@ NeverminedEvent.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -246,9 +246,9 @@ NeverminedEvent.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -258,69 +258,69 @@ NeverminedEvent.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -328,9 +328,9 @@ NeverminedEvent.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -340,38 +340,38 @@ NeverminedEvent.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -379,7 +379,7 @@ NeverminedEvent.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -391,8 +391,8 @@ It checks if an event exists on the contract definition #### Parameters -| Name | Type | Description | -| :---------- | :------- | :------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `eventName` | `string` | the event name | #### Returns @@ -403,9 +403,9 @@ true if the event exists, false otherwise #### Defined in -[src/events/ContractEvent.ts:111](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/ContractEvent.ts#L111) +[src/events/ContractEvent.ts:111](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/ContractEvent.ts#L111) ---- +___ ### filterToArgs @@ -415,10 +415,10 @@ It returns the indexed parameters of an event #### Parameters -| Name | Type | Description | -| :---------- | :------------------------------------------------------------ | :-------------------- | -| `eventName` | `string` | the name of the event | -| `filter` | [`FilterContractEvent`](../interfaces/FilterContractEvent.md) | tge event filter | +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` | the name of the event | +| `filter` | [`FilterContractEvent`](../interfaces/FilterContractEvent.md) | tge event filter | #### Returns @@ -428,9 +428,9 @@ the array of indexed parameters #### Defined in -[src/events/ContractEvent.ts:126](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/ContractEvent.ts#L126) +[src/events/ContractEvent.ts:126](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/ContractEvent.ts#L126) ---- +___ ### getBlockNumber @@ -450,9 +450,9 @@ the block number #### Defined in -[src/events/ContractEvent.ts:102](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/ContractEvent.ts#L102) +[src/events/ContractEvent.ts:102](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/ContractEvent.ts#L102) ---- +___ ### getEventData @@ -462,8 +462,8 @@ It returns the events matching a given filter #### Parameters -| Name | Type | Description | -| :-------- | :---------------------------------------------- | :------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `options` | [`EventOptions`](../interfaces/EventOptions.md) | event filter options | #### Returns @@ -478,9 +478,9 @@ It returns the events matching a given filter #### Defined in -[src/events/ContractEvent.ts:41](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/ContractEvent.ts#L41) +[src/events/ContractEvent.ts:41](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/ContractEvent.ts#L41) ---- +___ ### getPastEvents @@ -491,8 +491,8 @@ This necessary for some networks and/or web3 providers which limit the number of #### Parameters -| Name | Type | Description | -| :-------- | :---------------------------------------------- | :------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `options` | [`EventOptions`](../interfaces/EventOptions.md) | event filter options | #### Returns @@ -507,9 +507,9 @@ This necessary for some networks and/or web3 providers which limit the number of #### Defined in -[src/events/ContractEvent.ts:72](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/ContractEvent.ts#L72) +[src/events/ContractEvent.ts:72](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/ContractEvent.ts#L72) ---- +___ ### once @@ -519,11 +519,11 @@ Subscribes to a contract event and waits for the first event to happen #### Parameters -| Name | Type | Default value | Description | -| :--------- | :------------------------------------------------------------------------ | :------------ | :------------------------------------------- | -| `callback` | (`events`: [`EventResult`](../code-reference.md#eventresult)[]) => `void` | `undefined` | function called when the event is triggered | -| `options` | [`EventOptions`](../interfaces/EventOptions.md) | `undefined` | event filter options | -| `timeout` | `number` | `15_000` | maximum time to wait for the event to happen | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `callback` | (`events`: [`EventResult`](../code-reference.md#eventresult)[]) => `void` | `undefined` | function called when the event is triggered | +| `options` | [`EventOptions`](../interfaces/EventOptions.md) | `undefined` | event filter options | +| `timeout` | `number` | `15_000` | maximum time to wait for the event to happen | #### Returns @@ -537,9 +537,9 @@ Promise with the event data #### Defined in -[src/events/NeverminedEvent.ts:60](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/NeverminedEvent.ts#L60) +[src/events/NeverminedEvent.ts:60](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/NeverminedEvent.ts#L60) ---- +___ ### setInstanceConfig @@ -547,8 +547,8 @@ Promise with the event data #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -561,9 +561,9 @@ Promise with the event data #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### subscribe @@ -573,10 +573,10 @@ Subscribes to a contract event #### Parameters -| Name | Type | Description | -| :--------- | :------------------------------------------------------------------------ | :------------------------------------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `callback` | (`events`: [`EventResult`](../code-reference.md#eventresult)[]) => `void` | function called when the event is triggered | -| `options` | [`EventOptions`](../interfaces/EventOptions.md) | event filter options | +| `options` | [`EventOptions`](../interfaces/EventOptions.md) | event filter options | #### Returns @@ -590,9 +590,9 @@ Subscribes to a contract event #### Defined in -[src/events/NeverminedEvent.ts:38](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/NeverminedEvent.ts#L38) +[src/events/NeverminedEvent.ts:38](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/NeverminedEvent.ts#L38) ---- +___ ### getInstance @@ -602,12 +602,12 @@ It gets a new instance of ContractEvent #### Parameters -| Name | Type | Description | -| :------------- | :---------------------------------------------- | :---------------------------- | -| `contract` | [`ContractBase`](ContractBase.md) | contract instance | +| Name | Type | Description | +| :------ | :------ | :------ | +| `contract` | [`ContractBase`](ContractBase.md) | contract instance | | `eventEmitter` | [`EventEmitter`](../interfaces/EventEmitter.md) | events emitter implementation | -| `nevermined` | [`Nevermined`](Nevermined.md) | the Nevermined instance | -| `client` | [`Web3Clients`](../interfaces/Web3Clients.md) | the blockchain client | +| `nevermined` | [`Nevermined`](Nevermined.md) | the Nevermined instance | +| `client` | [`Web3Clients`](../interfaces/Web3Clients.md) | the blockchain client | #### Returns @@ -621,9 +621,9 @@ the ContractEvent instance #### Defined in -[src/events/ContractEvent.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/ContractEvent.ts#L21) +[src/events/ContractEvent.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/ContractEvent.ts#L21) ---- +___ ### setInstanceConfig @@ -631,15 +631,15 @@ the ContractEvent instance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -652,4 +652,4 @@ the ContractEvent instance #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/ContractHandler.md b/docs/nevermined-sdk/api-reference/classes/ContractHandler.md index a10c245375..4d10d15a30 100644 --- a/docs/nevermined-sdk/api-reference/classes/ContractHandler.md +++ b/docs/nevermined-sdk/api-reference/classes/ContractHandler.md @@ -59,8 +59,8 @@ #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -73,7 +73,7 @@ #### Defined in -[src/keeper/ContractHandler.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/ContractHandler.ts#L51) +[src/keeper/ContractHandler.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/ContractHandler.ts#L51) ## Properties @@ -83,9 +83,9 @@ #### Defined in -[src/keeper/ContractHandler.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/ContractHandler.ts#L15) +[src/keeper/ContractHandler.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/ContractHandler.ts#L15) ---- +___ ### versions @@ -93,7 +93,7 @@ #### Defined in -[src/keeper/ContractHandler.ts:17](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/ContractHandler.ts#L17) +[src/keeper/ContractHandler.ts:17](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/ContractHandler.ts#L17) ## Accessors @@ -111,9 +111,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -129,9 +129,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -147,9 +147,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -165,9 +165,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -183,9 +183,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -201,9 +201,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -219,9 +219,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -237,9 +237,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -249,69 +249,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -319,9 +319,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -331,38 +331,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -370,7 +370,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -380,8 +380,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `address` | `string` | #### Returns @@ -390,34 +390,34 @@ Instantiable.walletClient #### Defined in -[src/keeper/ContractHandler.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/ContractHandler.ts#L75) +[src/keeper/ContractHandler.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/ContractHandler.ts#L75) ---- +___ ### deployAbi -▸ **deployAbi**(`artifact`, `from`, `args?`): `Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> +▸ **deployAbi**(`artifact`, `from`, `args?`): `Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> #### Parameters -| Name | Type | Default value | -| :------------------ | :---------------------------- | :------------ | -| `artifact` | `Object` | `undefined` | -| `artifact.abi` | `Abi` | `undefined` | -| `artifact.bytecode` | \`0x$\{string}\` | `undefined` | -| `artifact.name?` | `string` | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `args` | `string`[] | `[]` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `artifact` | `Object` | `undefined` | +| `artifact.abi` | `Abi` | `undefined` | +| `artifact.bytecode` | \`0x$\{string}\` | `undefined` | +| `artifact.name?` | `string` | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `args` | `string`[] | `[]` | #### Returns -`Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> +`Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> #### Defined in -[src/keeper/ContractHandler.ts:79](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/ContractHandler.ts#L79) +[src/keeper/ContractHandler.ts:79](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/ContractHandler.ts#L79) ---- +___ ### getContractArtifact @@ -425,10 +425,10 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | -| `contractName` | `string` | -| `networkName` | `string` | +| Name | Type | +| :------ | :------ | +| `contractName` | `string` | +| `networkName` | `string` | | `artifactsFolder` | `string` | #### Returns @@ -437,9 +437,9 @@ Instantiable.walletClient #### Defined in -[src/keeper/ContractHandler.ts:87](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/ContractHandler.ts#L87) +[src/keeper/ContractHandler.ts:87](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/ContractHandler.ts#L87) ---- +___ ### getContractFromArtifacts @@ -447,12 +447,12 @@ Instantiable.walletClient #### Parameters -| Name | Type | Default value | -| :---------------- | :-------- | :------------ | -| `what` | `string` | `undefined` | -| `optional` | `boolean` | `false` | -| `artifactsFolder` | `string` | `undefined` | -| `address?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `what` | `string` | `undefined` | +| `optional` | `boolean` | `false` | +| `artifactsFolder` | `string` | `undefined` | +| `address?` | `string` | `undefined` | #### Returns @@ -460,9 +460,9 @@ Instantiable.walletClient #### Defined in -[src/keeper/ContractHandler.ts:130](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/ContractHandler.ts#L130) +[src/keeper/ContractHandler.ts:130](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/ContractHandler.ts#L130) ---- +___ ### getVersionFromArtifact @@ -470,9 +470,9 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | -| `contractName` | `string` | +| Name | Type | +| :------ | :------ | +| `contractName` | `string` | | `artifactsFolder` | `string` | #### Returns @@ -481,9 +481,9 @@ Instantiable.walletClient #### Defined in -[src/keeper/ContractHandler.ts:56](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/ContractHandler.ts#L56) +[src/keeper/ContractHandler.ts:56](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/ContractHandler.ts#L56) ---- +___ ### loadContractFromAbi @@ -491,13 +491,13 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | -| `what` | `string` | -| `where` | `string` | -| `networkId` | `number` | +| Name | Type | +| :------ | :------ | +| `what` | `string` | +| `where` | `string` | +| `networkId` | `number` | | `artifactsFolder` | `string` | -| `address?` | `string` | +| `address?` | `string` | #### Returns @@ -505,9 +505,9 @@ Instantiable.walletClient #### Defined in -[src/keeper/ContractHandler.ts:105](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/ContractHandler.ts#L105) +[src/keeper/ContractHandler.ts:105](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/ContractHandler.ts#L105) ---- +___ ### setInstanceConfig @@ -515,8 +515,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -529,9 +529,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### fetchJson @@ -539,8 +539,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :----- | :---- | +| Name | Type | +| :------ | :------ | | `path` | `any` | #### Returns @@ -549,9 +549,9 @@ Instantiable.walletClient #### Defined in -[src/keeper/ContractHandler.ts:181](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/ContractHandler.ts#L181) +[src/keeper/ContractHandler.ts:181](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/ContractHandler.ts#L181) ---- +___ ### getABIArtifact @@ -559,11 +559,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | Default value | -| :---------------- | :------- | :--------------- | -| `contractName` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `contractName` | `string` | `undefined` | | `artifactsFolder` | `string` | `'../artifacts'` | -| `networkName?` | `string` | `undefined` | +| `networkName?` | `string` | `undefined` | #### Returns @@ -571,9 +571,9 @@ Instantiable.walletClient #### Defined in -[src/keeper/ContractHandler.ts:154](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/ContractHandler.ts#L154) +[src/keeper/ContractHandler.ts:154](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/ContractHandler.ts#L154) ---- +___ ### getContract @@ -581,11 +581,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :---------- | :------- | -| `what` | `string` | +| Name | Type | +| :------ | :------ | +| `what` | `string` | | `networkId` | `number` | -| `address?` | `string` | +| `address?` | `string` | #### Returns @@ -593,9 +593,9 @@ Instantiable.walletClient #### Defined in -[src/keeper/ContractHandler.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/ContractHandler.ts#L19) +[src/keeper/ContractHandler.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/ContractHandler.ts#L19) ---- +___ ### getHash @@ -603,11 +603,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :---------- | :------- | -| `what` | `string` | +| Name | Type | +| :------ | :------ | +| `what` | `string` | | `networkId` | `number` | -| `address?` | `string` | +| `address?` | `string` | #### Returns @@ -615,9 +615,9 @@ Instantiable.walletClient #### Defined in -[src/keeper/ContractHandler.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/ContractHandler.ts#L47) +[src/keeper/ContractHandler.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/ContractHandler.ts#L47) ---- +___ ### getInstance @@ -625,8 +625,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -639,9 +639,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### getVersion @@ -649,11 +649,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :---------- | :------- | -| `what` | `string` | +| Name | Type | +| :------ | :------ | +| `what` | `string` | | `networkId` | `number` | -| `address?` | `string` | +| `address?` | `string` | #### Returns @@ -661,9 +661,9 @@ Instantiable.walletClient #### Defined in -[src/keeper/ContractHandler.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/ContractHandler.ts#L24) +[src/keeper/ContractHandler.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/ContractHandler.ts#L24) ---- +___ ### hasContract @@ -671,11 +671,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :---------- | :------- | -| `what` | `string` | +| Name | Type | +| :------ | :------ | +| `what` | `string` | | `networkId` | `number` | -| `address?` | `string` | +| `address?` | `string` | #### Returns @@ -683,9 +683,9 @@ Instantiable.walletClient #### Defined in -[src/keeper/ContractHandler.ts:41](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/ContractHandler.ts#L41) +[src/keeper/ContractHandler.ts:41](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/ContractHandler.ts#L41) ---- +___ ### setContract @@ -693,13 +693,13 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :----------------- | :------- | -| `what` | `string` | -| `networkId` | `number` | -| `contractInstance` | `any` | -| `address?` | `string` | -| `version?` | `string` | +| Name | Type | +| :------ | :------ | +| `what` | `string` | +| `networkId` | `number` | +| `contractInstance` | `any` | +| `address?` | `string` | +| `version?` | `string` | #### Returns @@ -707,9 +707,9 @@ Instantiable.walletClient #### Defined in -[src/keeper/ContractHandler.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/ContractHandler.ts#L29) +[src/keeper/ContractHandler.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/ContractHandler.ts#L29) ---- +___ ### setInstanceConfig @@ -717,15 +717,15 @@ Instantiable.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -738,4 +738,4 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/CurveRoyalties.md b/docs/nevermined-sdk/api-reference/classes/CurveRoyalties.md index e517566848..3c4444f544 100644 --- a/docs/nevermined-sdk/api-reference/classes/CurveRoyalties.md +++ b/docs/nevermined-sdk/api-reference/classes/CurveRoyalties.md @@ -58,8 +58,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -72,7 +72,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -86,9 +86,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -100,9 +100,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -114,9 +114,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -128,9 +128,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -142,7 +142,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -160,9 +160,9 @@ RoyaltyScheme.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -178,9 +178,9 @@ RoyaltyScheme.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -196,9 +196,9 @@ RoyaltyScheme.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -214,9 +214,9 @@ RoyaltyScheme.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -232,9 +232,9 @@ RoyaltyScheme.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -250,9 +250,9 @@ RoyaltyScheme.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -268,9 +268,9 @@ RoyaltyScheme.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -286,9 +286,9 @@ RoyaltyScheme.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -298,69 +298,69 @@ RoyaltyScheme.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -368,9 +368,9 @@ RoyaltyScheme.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -380,38 +380,38 @@ RoyaltyScheme.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -419,7 +419,7 @@ RoyaltyScheme.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -430,16 +430,16 @@ RoyaltyScheme.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -451,9 +451,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### getFromAddress @@ -461,8 +461,8 @@ RoyaltyScheme.walletClient #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -475,9 +475,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getRoyalty @@ -485,8 +485,8 @@ RoyaltyScheme.walletClient #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -499,24 +499,24 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:28](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L28) +[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:28](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L28) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -524,9 +524,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -534,11 +534,11 @@ RoyaltyScheme.walletClient #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -550,9 +550,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### send @@ -560,12 +560,12 @@ RoyaltyScheme.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -577,9 +577,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -587,12 +587,12 @@ RoyaltyScheme.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -604,9 +604,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -614,8 +614,8 @@ RoyaltyScheme.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -628,9 +628,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### setRoyalty @@ -638,11 +638,11 @@ RoyaltyScheme.walletClient #### Parameters -| Name | Type | -| :---------- | :---------------------------------------------- | -| `did` | `string` | -| `amount` | `number` | -| `from` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `amount` | `number` | +| `from` | [`NvmAccount`](NvmAccount.md) | | `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -655,9 +655,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L24) +[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L24) ---- +___ ### someLog @@ -665,8 +665,8 @@ RoyaltyScheme.walletClient #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -679,9 +679,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -689,8 +689,8 @@ RoyaltyScheme.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -703,9 +703,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/royalties/CurveRoyalties.ts:5](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/royalties/CurveRoyalties.ts#L5) +[src/keeper/contracts/royalties/CurveRoyalties.ts:5](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/royalties/CurveRoyalties.ts#L5) ---- +___ ### setInstanceConfig @@ -713,15 +713,15 @@ RoyaltyScheme.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -734,4 +734,4 @@ RoyaltyScheme.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/CustomToken.md b/docs/nevermined-sdk/api-reference/classes/CustomToken.md index 9b915714f4..622bce2b12 100644 --- a/docs/nevermined-sdk/api-reference/classes/CustomToken.md +++ b/docs/nevermined-sdk/api-reference/classes/CustomToken.md @@ -21,7 +21,7 @@ - [contractName](CustomToken.md#contractname) - [events](CustomToken.md#events) - [version](CustomToken.md#version) -- [ERC20_ABI](CustomToken.md#erc20_abi) +- [ERC20\_ABI](CustomToken.md#erc20_abi) ### Accessors @@ -67,8 +67,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -81,7 +81,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -95,9 +95,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -109,9 +109,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -123,9 +123,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -137,9 +137,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -151,13 +151,13 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ---- +___ -### ERC20_ABI +### ERC20\_ABI -▪ `Static` **ERC20_ABI**: `string`[] +▪ `Static` **ERC20\_ABI**: `string`[] #### Inherited from @@ -165,7 +165,7 @@ #### Defined in -[src/keeper/contracts/Token.ts:8](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L8) +[src/keeper/contracts/Token.ts:8](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L8) ## Accessors @@ -183,9 +183,9 @@ Token.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -201,9 +201,9 @@ Token.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -219,9 +219,9 @@ Token.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -237,9 +237,9 @@ Token.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -255,9 +255,9 @@ Token.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -273,9 +273,9 @@ Token.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -291,9 +291,9 @@ Token.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -309,9 +309,9 @@ Token.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -321,69 +321,69 @@ Token.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -391,9 +391,9 @@ Token.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -403,38 +403,38 @@ Token.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -442,7 +442,7 @@ Token.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -452,11 +452,11 @@ Token.walletClient #### Parameters -| Name | Type | -| :---------- | :---------------------------------------------- | -| `to` | `string` | -| `price` | `bigint` | -| `from` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `to` | `string` | +| `price` | `bigint` | +| `from` | [`NvmAccount`](NvmAccount.md) | | `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -469,9 +469,9 @@ Token.walletClient #### Defined in -[src/keeper/contracts/Token.ts:28](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L28) +[src/keeper/contracts/Token.ts:28](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L28) ---- +___ ### balanceOf @@ -479,8 +479,8 @@ Token.walletClient #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `address` | `string` | #### Returns @@ -493,9 +493,9 @@ Token.walletClient #### Defined in -[src/keeper/contracts/Token.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L44) +[src/keeper/contracts/Token.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L44) ---- +___ ### balanceOfConverted @@ -503,8 +503,8 @@ Token.walletClient #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `address` | `string` | #### Returns @@ -517,9 +517,9 @@ Token.walletClient #### Defined in -[src/keeper/contracts/Token.ts:36](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L36) +[src/keeper/contracts/Token.ts:36](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L36) ---- +___ ### call @@ -528,16 +528,16 @@ Token.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -549,9 +549,9 @@ Token.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### decimals @@ -567,9 +567,9 @@ Token.walletClient #### Defined in -[src/keeper/contracts/Token.ts:32](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L32) +[src/keeper/contracts/Token.ts:32](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L32) ---- +___ ### getFromAddress @@ -577,8 +577,8 @@ Token.walletClient #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -591,24 +591,24 @@ Token.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -616,9 +616,9 @@ Token.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -626,11 +626,11 @@ Token.walletClient #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -642,9 +642,9 @@ Token.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### name @@ -660,9 +660,9 @@ Token.walletClient #### Defined in -[src/keeper/contracts/Token.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L52) +[src/keeper/contracts/Token.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L52) ---- +___ ### send @@ -670,12 +670,12 @@ Token.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -687,9 +687,9 @@ Token.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -697,12 +697,12 @@ Token.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -714,9 +714,9 @@ Token.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -724,8 +724,8 @@ Token.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -738,9 +738,9 @@ Token.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -748,8 +748,8 @@ Token.walletClient #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -762,9 +762,9 @@ Token.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### strBalanceOf @@ -772,8 +772,8 @@ Token.walletClient #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `address` | `string` | #### Returns @@ -786,9 +786,9 @@ Token.walletClient #### Defined in -[src/keeper/contracts/Token.ts:40](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L40) +[src/keeper/contracts/Token.ts:40](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L40) ---- +___ ### symbol @@ -804,9 +804,9 @@ Token.walletClient #### Defined in -[src/keeper/contracts/Token.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L48) +[src/keeper/contracts/Token.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L48) ---- +___ ### totalSupply @@ -822,9 +822,9 @@ Token.walletClient #### Defined in -[src/keeper/contracts/Token.ts:56](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L56) +[src/keeper/contracts/Token.ts:56](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L56) ---- +___ ### transfer @@ -832,11 +832,11 @@ Token.walletClient #### Parameters -| Name | Type | -| :---------- | :---------------------------------------------- | -| `to` | `string` | -| `amount` | `bigint` | -| `from` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `to` | `string` | +| `amount` | `bigint` | +| `from` | [`NvmAccount`](NvmAccount.md) | | `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -849,9 +849,9 @@ Token.walletClient #### Defined in -[src/keeper/contracts/Token.ts:60](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L60) +[src/keeper/contracts/Token.ts:60](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L60) ---- +___ ### getInstance @@ -859,8 +859,8 @@ Token.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -873,9 +873,9 @@ Token.walletClient #### Defined in -[src/keeper/contracts/Token.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L22) +[src/keeper/contracts/Token.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L22) ---- +___ ### getInstanceByAddress @@ -883,10 +883,10 @@ Token.walletClient #### Parameters -| Name | Type | -| :-------- | :---------------------------------------------------------- | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | -| `address` | `string` | +| Name | Type | +| :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | +| `address` | `string` | #### Returns @@ -894,9 +894,9 @@ Token.walletClient #### Defined in -[src/keeper/contracts/CustomToken.ts:6](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/CustomToken.ts#L6) +[src/keeper/contracts/CustomToken.ts:6](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/CustomToken.ts#L6) ---- +___ ### setInstanceConfig @@ -904,15 +904,15 @@ Token.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -925,4 +925,4 @@ Token.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/DDO.md b/docs/nevermined-sdk/api-reference/classes/DDO.md index 78057bc779..6c61d572ba 100644 --- a/docs/nevermined-sdk/api-reference/classes/DDO.md +++ b/docs/nevermined-sdk/api-reference/classes/DDO.md @@ -75,8 +75,8 @@ Contains all the metadata related to an asset, including the description and the #### Parameters -| Name | Type | -| :---- | :--------------------------- | +| Name | Type | +| :------ | :------ | | `ddo` | `Partial`\<[`DDO`](DDO.md)\> | #### Returns @@ -85,7 +85,7 @@ Contains all the metadata related to an asset, including the description and the #### Defined in -[src/ddo/DDO.ts:232](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L232) +[src/ddo/DDO.ts:232](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L232) ## Properties @@ -95,9 +95,9 @@ Contains all the metadata related to an asset, including the description and the #### Defined in -[src/ddo/DDO.ts:209](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L209) +[src/ddo/DDO.ts:209](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L209) ---- +___ ### \_nvm @@ -105,9 +105,9 @@ Contains all the metadata related to an asset, including the description and the #### Defined in -[src/ddo/DDO.ts:218](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L218) +[src/ddo/DDO.ts:218](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L218) ---- +___ ### authentication @@ -115,9 +115,9 @@ Contains all the metadata related to an asset, including the description and the #### Defined in -[src/ddo/DDO.ts:226](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L226) +[src/ddo/DDO.ts:226](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L226) ---- +___ ### created @@ -125,9 +125,9 @@ Contains all the metadata related to an asset, including the description and the #### Defined in -[src/ddo/DDO.ts:220](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L220) +[src/ddo/DDO.ts:220](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L220) ---- +___ ### didSeed @@ -135,9 +135,9 @@ Contains all the metadata related to an asset, including the description and the #### Defined in -[src/ddo/DDO.ts:216](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L216) +[src/ddo/DDO.ts:216](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L216) ---- +___ ### id @@ -147,9 +147,9 @@ DID, decentralizes ID. #### Defined in -[src/ddo/DDO.ts:214](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L214) +[src/ddo/DDO.ts:214](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L214) ---- +___ ### proof @@ -157,9 +157,9 @@ DID, decentralizes ID. #### Defined in -[src/ddo/DDO.ts:230](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L230) +[src/ddo/DDO.ts:230](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L230) ---- +___ ### publicKey @@ -167,9 +167,9 @@ DID, decentralizes ID. #### Defined in -[src/ddo/DDO.ts:224](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L224) +[src/ddo/DDO.ts:224](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L224) ---- +___ ### service @@ -177,9 +177,9 @@ DID, decentralizes ID. #### Defined in -[src/ddo/DDO.ts:228](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L228) +[src/ddo/DDO.ts:228](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L228) ---- +___ ### updated @@ -187,7 +187,7 @@ DID, decentralizes ID. #### Defined in -[src/ddo/DDO.ts:222](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L222) +[src/ddo/DDO.ts:222](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L222) ## Methods @@ -199,10 +199,10 @@ Adds a default metadata service to the DDO. #### Parameters -| Name | Type | Description | -| :--------------- | :-------------------------------------- | :------------- | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | metadata | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | nft attributes | +| Name | Type | Description | +| :------ | :------ | :------ | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | metadata | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | nft attributes | #### Returns @@ -212,9 +212,9 @@ main metadata attributes #### Defined in -[src/ddo/DDO.ts:474](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L474) +[src/ddo/DDO.ts:474](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L474) ---- +___ ### addProof @@ -224,8 +224,8 @@ Generates and adds a proof using personal sign on the DDO. #### Parameters -| Name | Type | Description | -| :---------- | :------- | :-------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `publicKey` | `string` | Public key to be used on personal sign. | #### Returns @@ -236,9 +236,9 @@ void. #### Defined in -[src/ddo/DDO.ts:424](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L424) +[src/ddo/DDO.ts:424](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L424) ---- +___ ### addService @@ -248,8 +248,8 @@ Adds a service to the DDO. #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | #### Returns @@ -258,9 +258,9 @@ Adds a service to the DDO. #### Defined in -[src/ddo/DDO.ts:446](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L446) +[src/ddo/DDO.ts:446](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L446) ---- +___ ### addSignature @@ -270,10 +270,10 @@ It adds a signature to the the proof object of the DDO #### Parameters -| Name | Type | Description | -| :----------- | :---------------------------- | :------------------------- | -| `nevermined` | [`Nevermined`](Nevermined.md) | nevermined object | -| `publicKey` | `string` | public key to sign the DDO | +| Name | Type | Description | +| :------ | :------ | :------ | +| `nevermined` | [`Nevermined`](Nevermined.md) | nevermined object | +| `publicKey` | `string` | public key to sign the DDO | #### Returns @@ -281,9 +281,9 @@ It adds a signature to the the proof object of the DDO #### Defined in -[src/ddo/DDO.ts:556](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L556) +[src/ddo/DDO.ts:556](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L556) ---- +___ ### assignDid @@ -293,11 +293,11 @@ Assign a DID to the DDO #### Parameters -| Name | Type | Description | -| :------------ | :------------------------------ | :-------------------------- | -| `didSeed` | `string` | DID seed | -| `didRegistry` | [`DIDRegistry`](DIDRegistry.md) | DIDRegistry contract | -| `publisher` | [`NvmAccount`](NvmAccount.md) | account registering the DID | +| Name | Type | Description | +| :------ | :------ | :------ | +| `didSeed` | `string` | DID seed | +| `didRegistry` | [`DIDRegistry`](DIDRegistry.md) | DIDRegistry contract | +| `publisher` | [`NvmAccount`](NvmAccount.md) | account registering the DID | #### Returns @@ -305,9 +305,9 @@ Assign a DID to the DDO #### Defined in -[src/ddo/DDO.ts:534](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L534) +[src/ddo/DDO.ts:534](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L534) ---- +___ ### checksum @@ -315,8 +315,8 @@ Assign a DID to the DDO #### Parameters -| Name | Type | -| :----- | :------- | +| Name | Type | +| :------ | :------ | | `seed` | `string` | #### Returns @@ -325,9 +325,9 @@ Assign a DID to the DDO #### Defined in -[src/ddo/DDO.ts:386](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L386) +[src/ddo/DDO.ts:386](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L386) ---- +___ ### findServiceByIndex @@ -337,14 +337,14 @@ Finds a service of a DDO by index number. #### Type parameters -| Name | Type | -| :--- | :-------------------------------------------------------- | -| `T` | extends [`ServiceType`](../code-reference.md#servicetype) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`ServiceType`](../code-reference.md#servicetype) | #### Parameters -| Name | Type | Description | -| :------ | :------- | :------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `index` | `number` | index of the service in the DDO. | #### Returns @@ -355,9 +355,9 @@ Finds a service of a DDO by index number. #### Defined in -[src/ddo/DDO.ts:291](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L291) +[src/ddo/DDO.ts:291](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L291) ---- +___ ### findServiceByReference @@ -367,14 +367,14 @@ Finds a service of a DDO by index. #### Type parameters -| Name | Type | -| :--- | :-------------------------------------------------------- | -| `T` | extends [`ServiceType`](../code-reference.md#servicetype) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`ServiceType`](../code-reference.md#servicetype) | #### Parameters -| Name | Type | Description | -| :----------------- | :------------------------------------------------------------ | :---------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | reference to the service (index or type). | #### Returns @@ -385,9 +385,9 @@ Service. #### Defined in -[src/ddo/DDO.ts:325](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L325) +[src/ddo/DDO.ts:325](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L325) ---- +___ ### findServiceByType @@ -397,15 +397,15 @@ Finds the first service of a DDO by type. #### Type parameters -| Name | Type | -| :--- | :-------------------------------------------------------- | -| `T` | extends [`ServiceType`](../code-reference.md#servicetype) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`ServiceType`](../code-reference.md#servicetype) | #### Parameters -| Name | Type | Description | -| :------------ | :--- | :------------------------------------ | -| `serviceType` | `T` | Service type used by find the service | +| Name | Type | Description | +| :------ | :------ | :------ | +| `serviceType` | `T` | Service type used by find the service | #### Returns @@ -419,9 +419,9 @@ Finds the first service of a DDO by type. #### Defined in -[src/ddo/DDO.ts:311](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L311) +[src/ddo/DDO.ts:311](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L311) ---- +___ ### generateDidSeed @@ -431,9 +431,9 @@ It generates a DID seed from a seed #### Parameters -| Name | Type | Description | -| :----- | :---- | :---------- | -| `seed` | `any` | the seed | +| Name | Type | Description | +| :------ | :------ | :------ | +| `seed` | `any` | the seed | #### Returns @@ -443,9 +443,9 @@ the string represeing the DID seed #### Defined in -[src/ddo/DDO.ts:547](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L547) +[src/ddo/DDO.ts:547](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L547) ---- +___ ### generateProof @@ -455,8 +455,8 @@ Generates proof using personal sign. #### Parameters -| Name | Type | Description | -| :---------- | :------- | :-------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `publicKey` | `string` | Public key to be used on personal sign. | #### Returns @@ -467,9 +467,9 @@ Proof object. #### Defined in -[src/ddo/DDO.ts:395](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L395) +[src/ddo/DDO.ts:395](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L395) ---- +___ ### getAssetPriceFromDDOByServiceType @@ -479,8 +479,8 @@ It gets the AssetPrice from a service given the serviceType #### Parameters -| Name | Type | Description | -| :-------- | :------------------------------------------------ | :----------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `service` | [`ServiceType`](../code-reference.md#servicetype) | the service to search in | #### Returns @@ -491,9 +491,9 @@ the AssetPrice object #### Defined in -[src/ddo/DDO.ts:711](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L711) +[src/ddo/DDO.ts:711](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L711) ---- +___ ### getPriceByService @@ -503,9 +503,9 @@ Get the total price of a service. #### Parameters -| Name | Type | Default value | Description | -| :------------ | :------------------------------------------------ | :------------ | :----------- | -| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | `'access'` | Service type | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | `'access'` | Service type | #### Returns @@ -525,9 +525,9 @@ const price = ddo.getPriceByService('nft-access') #### Defined in -[src/ddo/DDO.ts:376](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L376) +[src/ddo/DDO.ts:376](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L376) ---- +___ ### getProofChecksum @@ -543,9 +543,9 @@ string containing the checksum of the proof. #### Defined in -[src/ddo/DDO.ts:415](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L415) +[src/ddo/DDO.ts:415](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L415) ---- +___ ### getServicesByType @@ -555,15 +555,15 @@ Gets all the services of a DDO with a specific type. #### Type parameters -| Name | Type | -| :--- | :-------------------------------------------------------- | -| `T` | extends [`ServiceType`](../code-reference.md#servicetype) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`ServiceType`](../code-reference.md#servicetype) | #### Parameters -| Name | Type | Description | -| :------------ | :--- | :------------ | -| `serviceType` | `T` | Service type. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `serviceType` | `T` | Service type. | #### Returns @@ -573,9 +573,9 @@ Gets all the services of a DDO with a specific type. #### Defined in -[src/ddo/DDO.ts:341](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L341) +[src/ddo/DDO.ts:341](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L341) ---- +___ ### reorderServices @@ -589,9 +589,9 @@ It reorders the services of the DDO using the service index #### Defined in -[src/ddo/DDO.ts:434](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L434) +[src/ddo/DDO.ts:434](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L434) ---- +___ ### replaceService @@ -601,10 +601,10 @@ Replaces a service in the DDO. #### Parameters -| Name | Type | -| :-------- | :------- | -| `index` | `number` | -| `service` | `any` | +| Name | Type | +| :------ | :------ | +| `index` | `number` | +| `service` | `any` | #### Returns @@ -612,9 +612,9 @@ Replaces a service in the DDO. #### Defined in -[src/ddo/DDO.ts:462](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L462) +[src/ddo/DDO.ts:462](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L462) ---- +___ ### serviceExists @@ -624,15 +624,15 @@ Checks if a service exists in the DDO. #### Type parameters -| Name | Type | -| :--- | :-------------------------------------------------------- | -| `T` | extends [`ServiceType`](../code-reference.md#servicetype) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`ServiceType`](../code-reference.md#servicetype) | #### Parameters -| Name | Type | Description | -| :------------ | :--- | :------------ | -| `serviceType` | `T` | Service type. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `serviceType` | `T` | Service type. | #### Returns @@ -642,9 +642,9 @@ true if service exists. #### Defined in -[src/ddo/DDO.ts:351](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L351) +[src/ddo/DDO.ts:351](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L351) ---- +___ ### serviceIndexExists @@ -654,8 +654,8 @@ Checks if a service index in the DDO. #### Parameters -| Name | Type | Description | -| :------------- | :------- | :------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `serviceIndex` | `number` | Service index. | #### Returns @@ -666,9 +666,9 @@ true if service exists. #### Defined in -[src/ddo/DDO.ts:361](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L361) +[src/ddo/DDO.ts:361](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L361) ---- +___ ### setAssetPriceFromDDOByService @@ -678,10 +678,10 @@ Given a service type, it sets the AssetPrice in the escrowPayment condition #### Parameters -| Name | Type | Description | -| :------------ | :------------------------------------------------ | :--------------------------- | -| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | the service to search in | -| `rewards` | [`AssetPrice`](AssetPrice.md) | the AssetPrice object to set | +| Name | Type | Description | +| :------ | :------ | :------ | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | the service to search in | +| `rewards` | [`AssetPrice`](AssetPrice.md) | the AssetPrice object to set | #### Returns @@ -689,9 +689,9 @@ Given a service type, it sets the AssetPrice in the escrowPayment condition #### Defined in -[src/ddo/DDO.ts:721](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L721) +[src/ddo/DDO.ts:721](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L721) ---- +___ ### setNFTRewardsFromService @@ -701,11 +701,11 @@ Given the service type it sets the AssetPrice and NFT holder #### Parameters -| Name | Type | Description | -| :-------------- | :------------------------------------------------ | :---------------------------- | -| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | the service type to search in | -| `rewards` | [`AssetPrice`](AssetPrice.md) | the AssetPrice object to set | -| `holderAddress` | `string` | the NFT Holder address to set | +| Name | Type | Description | +| :------ | :------ | :------ | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | the service type to search in | +| `rewards` | [`AssetPrice`](AssetPrice.md) | the AssetPrice object to set | +| `holderAddress` | `string` | the NFT Holder address to set | #### Returns @@ -713,9 +713,9 @@ Given the service type it sets the AssetPrice and NFT holder #### Defined in -[src/ddo/DDO.ts:748](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L748) +[src/ddo/DDO.ts:748](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L748) ---- +___ ### shortId @@ -731,9 +731,9 @@ the DID without the prefix #### Defined in -[src/ddo/DDO.ts:282](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L282) +[src/ddo/DDO.ts:282](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L282) ---- +___ ### updateMetadataService @@ -743,8 +743,8 @@ Updates a service in the DDO #### Parameters -| Name | Type | Description | -| :-------- | :---- | :------------------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `service` | `any` | the service to be updated | #### Returns @@ -753,9 +753,9 @@ Updates a service in the DDO #### Defined in -[src/ddo/DDO.ts:520](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L520) +[src/ddo/DDO.ts:520](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L520) ---- +___ ### updateService @@ -763,10 +763,10 @@ Updates a service in the DDO #### Parameters -| Name | Type | Default value | Description | -| :------------- | :------- | :------------ | :---------------------------------------------------- | -| `service` | `any` | `undefined` | the service to be updated | -| `serviceIndex` | `number` | `0` | the position of the service in the DDO.services array | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `service` | `any` | `undefined` | the service to be updated | +| `serviceIndex` | `number` | `0` | the position of the service in the DDO.services array | #### Returns @@ -779,9 +779,9 @@ Updates a service in the DDO #### Defined in -[src/ddo/DDO.ts:511](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L511) +[src/ddo/DDO.ts:511](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L511) ---- +___ ### createAuthorizationService @@ -791,11 +791,11 @@ It creates an authorization service that can be included later as part of a DDO #### Parameters -| Name | Type | Description | -| :------------------ | :------- | :--------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `neverminedNodeUri` | `string` | URL of the Nevermined Node managing this asset | -| `publicKey` | `string` | Public key of the user | -| `method` | `string` | Encryption method | +| `publicKey` | `string` | Public key of the user | +| `method` | `string` | Encryption method | #### Returns @@ -805,9 +805,9 @@ The authorization service #### Defined in -[src/ddo/DDO.ts:190](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L190) +[src/ddo/DDO.ts:190](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L190) ---- +___ ### deserialize @@ -817,8 +817,8 @@ Deserializes the DDO object. #### Parameters -| Name | Type | Description | -| :---------- | :------- | :----------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `ddoString` | `string` | The serialized [DDO](DDO.md) to be deserialized. | #### Returns @@ -829,9 +829,9 @@ The deserialized [DDO](DDO.md). #### Defined in -[src/ddo/DDO.ts:177](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L177) +[src/ddo/DDO.ts:177](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L177) ---- +___ ### findAndReplaceDDOAttribute @@ -841,11 +841,11 @@ Finds an attribute in the DDO and replace it with the given value #### Parameters -| Name | Type | Description | -| :---------- | :-------------- | :------------------------ | -| `ddo` | [`DDO`](DDO.md) | the originial DDO | -| `paramName` | `string` | the param name to replace | -| `value` | `string` | the new value | +| Name | Type | Description | +| :------ | :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | the originial DDO | +| `paramName` | `string` | the param name to replace | +| `value` | `string` | the new value | #### Returns @@ -855,9 +855,9 @@ the DDO with the replaced attribute #### Defined in -[src/ddo/DDO.ts:771](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L771) +[src/ddo/DDO.ts:771](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L771) ---- +___ ### findServiceConditionByName @@ -867,10 +867,10 @@ If fins a service condition by name #### Parameters -| Name | Type | Description | -| :-------- | :---------------------------------------------------- | :------------------------ | -| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | the service to search in | -| `name` | [`ConditionType`](../code-reference.md#conditiontype) | the name of the condition | +| Name | Type | Description | +| :------ | :------ | :------ | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | the service to search in | +| `name` | [`ConditionType`](../code-reference.md#conditiontype) | the name of the condition | #### Returns @@ -880,9 +880,9 @@ ServiceAgreementTemplateCondition the condition #### Defined in -[src/ddo/DDO.ts:568](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L568) +[src/ddo/DDO.ts:568](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L568) ---- +___ ### getAssetPriceFromService @@ -892,8 +892,8 @@ It gets the AssetPrice from a service with escrowPayment condition #### Parameters -| Name | Type | Description | -| :-------- | :------------------------------------------------ | :----------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | the service to search in | #### Returns @@ -904,9 +904,9 @@ the AssetPrice object #### Defined in -[src/ddo/DDO.ts:686](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L686) +[src/ddo/DDO.ts:686](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L686) ---- +___ ### getDIDFromService @@ -916,8 +916,8 @@ Gets the DID in the escrowPayment condition of the service #### Parameters -| Name | Type | Description | -| :-------- | :------------------------------------------------ | :----------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | the service to search in | #### Returns @@ -928,9 +928,9 @@ the DID #### Defined in -[src/ddo/DDO.ts:584](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L584) +[src/ddo/DDO.ts:584](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L584) ---- +___ ### getDurationFromService @@ -940,8 +940,8 @@ Gets the duration parameter in the transferNFT condition of the service #### Parameters -| Name | Type | Description | -| :-------- | :------------------------------------------------ | :----------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | the service to search in | #### Returns @@ -952,9 +952,9 @@ the duration of the subscription #### Defined in -[src/ddo/DDO.ts:641](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L641) +[src/ddo/DDO.ts:641](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L641) ---- +___ ### getInstance @@ -964,11 +964,11 @@ It gets an instance of a DDO with the basic structure #### Parameters -| Name | Type | Description | -| :----------------- | :------- | :-------------------------------- | -| `userId` | `string` | The unique identifier of the user | -| `publisherAddress` | `string` | The address of the publisher | -| `appId?` | `string` | The application id | +| Name | Type | Description | +| :------ | :------ | :------ | +| `userId` | `string` | The unique identifier of the user | +| `publisherAddress` | `string` | The address of the publisher | +| `appId?` | `string` | The application id | #### Returns @@ -978,9 +978,9 @@ a [DDO](DDO.md) instance #### Defined in -[src/ddo/DDO.ts:245](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L245) +[src/ddo/DDO.ts:245](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L245) ---- +___ ### getNFTTransferFromService @@ -990,8 +990,8 @@ Gets the nftTransfer parameter in the transferNFT condition of the service #### Parameters -| Name | Type | Description | -| :-------- | :------------------------------------------------ | :----------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | the service to search in | #### Returns @@ -1002,9 +1002,9 @@ if condition will do a nft transfer or a mint #### Defined in -[src/ddo/DDO.ts:630](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L630) +[src/ddo/DDO.ts:630](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L630) ---- +___ ### getNewDateFormatted @@ -1014,8 +1014,8 @@ It gets a new date formatted #### Parameters -| Name | Type | Description | -| :----- | :----- | :----------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `date` | `Date` | the date to format | #### Returns @@ -1026,9 +1026,9 @@ the date string formatted #### Defined in -[src/ddo/DDO.ts:274](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L274) +[src/ddo/DDO.ts:274](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L274) ---- +___ ### getNftAmountFromService @@ -1038,8 +1038,8 @@ Gets the number of NFTs in the transferNFT condition of the service #### Parameters -| Name | Type | Description | -| :-------- | :------------------------------------------------ | :----------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | the service to search in | #### Returns @@ -1050,9 +1050,9 @@ the number of NFTs #### Defined in -[src/ddo/DDO.ts:616](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L616) +[src/ddo/DDO.ts:616](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L616) ---- +___ ### getNftContractAddressFromService @@ -1062,8 +1062,8 @@ Gets the NFT Contract address used in the NFT Access or NFT Sales service #### Parameters -| Name | Type | Description | -| :-------- | :--------------------------------------------------------------------------------------------------------------- | :----------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `service` | [`ServiceNFTAccess`](../interfaces/ServiceNFTAccess.md) \| [`ServiceNFTSales`](../interfaces/ServiceNFTSales.md) | the service to search in | #### Returns @@ -1074,9 +1074,9 @@ the NFT contract address #### Defined in -[src/ddo/DDO.ts:670](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L670) +[src/ddo/DDO.ts:670](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L670) ---- +___ ### getNftHolderFromService @@ -1086,8 +1086,8 @@ Gets the NFT Holder in the transferNFT condition of the service #### Parameters -| Name | Type | Description | -| :-------- | :------------------------------------------------ | :----------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | the service to search in | #### Returns @@ -1098,9 +1098,9 @@ the NFT Holder address #### Defined in -[src/ddo/DDO.ts:594](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L594) +[src/ddo/DDO.ts:594](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L594) ---- +___ ### getParameterFromCondition @@ -1110,11 +1110,11 @@ Given a service, condition and param name it returns the value #### Parameters -| Name | Type | Description | -| :-------------- | :---------------------------------------------------- | :--------------------------------- | -| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | The service where the condition is | -| `conditionType` | [`ConditionType`](../code-reference.md#conditiontype) | the condition type | -| `paramName` | `string` | the param name | +| Name | Type | Description | +| :------ | :------ | :------ | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | The service where the condition is | +| `conditionType` | [`ConditionType`](../code-reference.md#conditiontype) | the condition type | +| `paramName` | `string` | the param name | #### Returns @@ -1124,9 +1124,9 @@ the value #### Defined in -[src/ddo/DDO.ts:652](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L652) +[src/ddo/DDO.ts:652](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L652) ---- +___ ### getTokenIdFromService @@ -1136,8 +1136,8 @@ Gets the NFT TokenId in the nftHolder condition of the service #### Parameters -| Name | Type | Description | -| :-------- | :------------------------------------------------ | :----------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | the service to search in | #### Returns @@ -1148,9 +1148,9 @@ the NFT Token Id #### Defined in -[src/ddo/DDO.ts:603](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L603) +[src/ddo/DDO.ts:603](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L603) ---- +___ ### serialize @@ -1160,8 +1160,8 @@ Serializes the DDO object. #### Parameters -| Name | Type | Description | -| :---- | :-------------- | :---------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `ddo` | [`DDO`](DDO.md) | The [DDO](DDO.md) to be serialized. | #### Returns @@ -1172,4 +1172,4 @@ DDO serialized. #### Defined in -[src/ddo/DDO.ts:168](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L168) +[src/ddo/DDO.ts:168](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L168) diff --git a/docs/nevermined-sdk/api-reference/classes/DDOConditionNotFoundError.md b/docs/nevermined-sdk/api-reference/classes/DDOConditionNotFoundError.md index d913ed3056..34617092ea 100644 --- a/docs/nevermined-sdk/api-reference/classes/DDOConditionNotFoundError.md +++ b/docs/nevermined-sdk/api-reference/classes/DDOConditionNotFoundError.md @@ -35,8 +35,8 @@ #### Parameters -| Name | Type | -| :-------------- | :------- | +| Name | Type | +| :------ | :------ | | `conditionName` | `string` | #### Returns @@ -49,7 +49,7 @@ #### Defined in -[src/errors/NeverminedErrors.ts:88](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/errors/NeverminedErrors.ts#L88) +[src/errors/NeverminedErrors.ts:88](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/errors/NeverminedErrors.ts#L88) ## Properties @@ -65,7 +65,7 @@ node_modules/typescript/lib/lib.es2022.error.d.ts:24 ---- +___ ### message @@ -79,7 +79,7 @@ node_modules/typescript/lib/lib.es2022.error.d.ts:24 node_modules/typescript/lib/lib.es5.d.ts:1077 ---- +___ ### name @@ -93,7 +93,7 @@ node_modules/typescript/lib/lib.es5.d.ts:1077 node_modules/typescript/lib/lib.es5.d.ts:1076 ---- +___ ### stack @@ -107,7 +107,7 @@ node_modules/typescript/lib/lib.es5.d.ts:1076 node_modules/typescript/lib/lib.es5.d.ts:1078 ---- +___ ### prepareStackTrace @@ -125,9 +125,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ##### Parameters -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | +| Name | Type | +| :------ | :------ | +| `err` | `Error` | | `stackTraces` | `CallSite`[] | ##### Returns @@ -142,7 +142,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces node_modules/@types/node/globals.d.ts:28 ---- +___ ### stackTraceLimit @@ -166,9 +166,9 @@ Create .stack property on a target object #### Parameters -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | | `constructorOpt?` | `Function` | #### Returns diff --git a/docs/nevermined-sdk/api-reference/classes/DDOError.md b/docs/nevermined-sdk/api-reference/classes/DDOError.md index 98789c43f7..e9d91d1609 100644 --- a/docs/nevermined-sdk/api-reference/classes/DDOError.md +++ b/docs/nevermined-sdk/api-reference/classes/DDOError.md @@ -45,10 +45,10 @@ #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `message` | `string` | -| `did?` | `string` | +| `did?` | `string` | #### Returns @@ -60,7 +60,7 @@ Error.constructor #### Defined in -[src/errors/NeverminedErrors.ts:62](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/errors/NeverminedErrors.ts#L62) +[src/errors/NeverminedErrors.ts:62](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/errors/NeverminedErrors.ts#L62) ## Properties @@ -76,7 +76,7 @@ Error.cause node_modules/typescript/lib/lib.es2022.error.d.ts:24 ---- +___ ### message @@ -90,7 +90,7 @@ Error.message node_modules/typescript/lib/lib.es5.d.ts:1077 ---- +___ ### name @@ -104,7 +104,7 @@ Error.name node_modules/typescript/lib/lib.es5.d.ts:1076 ---- +___ ### stack @@ -118,7 +118,7 @@ Error.stack node_modules/typescript/lib/lib.es5.d.ts:1078 ---- +___ ### prepareStackTrace @@ -136,9 +136,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ##### Parameters -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | +| Name | Type | +| :------ | :------ | +| `err` | `Error` | | `stackTraces` | `CallSite`[] | ##### Returns @@ -153,7 +153,7 @@ Error.prepareStackTrace node_modules/@types/node/globals.d.ts:28 ---- +___ ### stackTraceLimit @@ -177,9 +177,9 @@ Create .stack property on a target object #### Parameters -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | | `constructorOpt?` | `Function` | #### Returns diff --git a/docs/nevermined-sdk/api-reference/classes/DDOParamNotFoundError.md b/docs/nevermined-sdk/api-reference/classes/DDOParamNotFoundError.md index 26c0501f2a..64c36ce5c9 100644 --- a/docs/nevermined-sdk/api-reference/classes/DDOParamNotFoundError.md +++ b/docs/nevermined-sdk/api-reference/classes/DDOParamNotFoundError.md @@ -35,10 +35,10 @@ #### Parameters -| Name | Type | -| :-------------- | :------- | +| Name | Type | +| :------ | :------ | | `conditionName` | `string` | -| `paramName?` | `string` | +| `paramName?` | `string` | #### Returns @@ -50,7 +50,7 @@ #### Defined in -[src/errors/NeverminedErrors.ts:94](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/errors/NeverminedErrors.ts#L94) +[src/errors/NeverminedErrors.ts:94](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/errors/NeverminedErrors.ts#L94) ## Properties @@ -66,7 +66,7 @@ node_modules/typescript/lib/lib.es2022.error.d.ts:24 ---- +___ ### message @@ -80,7 +80,7 @@ node_modules/typescript/lib/lib.es2022.error.d.ts:24 node_modules/typescript/lib/lib.es5.d.ts:1077 ---- +___ ### name @@ -94,7 +94,7 @@ node_modules/typescript/lib/lib.es5.d.ts:1077 node_modules/typescript/lib/lib.es5.d.ts:1076 ---- +___ ### stack @@ -108,7 +108,7 @@ node_modules/typescript/lib/lib.es5.d.ts:1076 node_modules/typescript/lib/lib.es5.d.ts:1078 ---- +___ ### prepareStackTrace @@ -126,9 +126,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ##### Parameters -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | +| Name | Type | +| :------ | :------ | +| `err` | `Error` | | `stackTraces` | `CallSite`[] | ##### Returns @@ -143,7 +143,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces node_modules/@types/node/globals.d.ts:28 ---- +___ ### stackTraceLimit @@ -167,9 +167,9 @@ Create .stack property on a target object #### Parameters -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | | `constructorOpt?` | `Function` | #### Returns diff --git a/docs/nevermined-sdk/api-reference/classes/DDOPriceNotFoundError.md b/docs/nevermined-sdk/api-reference/classes/DDOPriceNotFoundError.md index e2e20fa2ac..f605a17434 100644 --- a/docs/nevermined-sdk/api-reference/classes/DDOPriceNotFoundError.md +++ b/docs/nevermined-sdk/api-reference/classes/DDOPriceNotFoundError.md @@ -35,10 +35,10 @@ #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `serviceType` | `string` | -| `did?` | `string` | +| `did?` | `string` | #### Returns @@ -50,7 +50,7 @@ #### Defined in -[src/errors/NeverminedErrors.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/errors/NeverminedErrors.ts#L100) +[src/errors/NeverminedErrors.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/errors/NeverminedErrors.ts#L100) ## Properties @@ -66,7 +66,7 @@ node_modules/typescript/lib/lib.es2022.error.d.ts:24 ---- +___ ### message @@ -80,7 +80,7 @@ node_modules/typescript/lib/lib.es2022.error.d.ts:24 node_modules/typescript/lib/lib.es5.d.ts:1077 ---- +___ ### name @@ -94,7 +94,7 @@ node_modules/typescript/lib/lib.es5.d.ts:1077 node_modules/typescript/lib/lib.es5.d.ts:1076 ---- +___ ### stack @@ -108,7 +108,7 @@ node_modules/typescript/lib/lib.es5.d.ts:1076 node_modules/typescript/lib/lib.es5.d.ts:1078 ---- +___ ### prepareStackTrace @@ -126,9 +126,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ##### Parameters -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | +| Name | Type | +| :------ | :------ | +| `err` | `Error` | | `stackTraces` | `CallSite`[] | ##### Returns @@ -143,7 +143,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces node_modules/@types/node/globals.d.ts:28 ---- +___ ### stackTraceLimit @@ -167,9 +167,9 @@ Create .stack property on a target object #### Parameters -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | | `constructorOpt?` | `Function` | #### Returns diff --git a/docs/nevermined-sdk/api-reference/classes/DDOServiceAlreadyExists.md b/docs/nevermined-sdk/api-reference/classes/DDOServiceAlreadyExists.md index b0bff52433..bb4dcc1fc8 100644 --- a/docs/nevermined-sdk/api-reference/classes/DDOServiceAlreadyExists.md +++ b/docs/nevermined-sdk/api-reference/classes/DDOServiceAlreadyExists.md @@ -35,10 +35,10 @@ #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `serviceType` | `string` | -| `index` | `number` | +| `index` | `number` | #### Returns @@ -50,7 +50,7 @@ #### Defined in -[src/errors/NeverminedErrors.ts:82](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/errors/NeverminedErrors.ts#L82) +[src/errors/NeverminedErrors.ts:82](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/errors/NeverminedErrors.ts#L82) ## Properties @@ -66,7 +66,7 @@ node_modules/typescript/lib/lib.es2022.error.d.ts:24 ---- +___ ### message @@ -80,7 +80,7 @@ node_modules/typescript/lib/lib.es2022.error.d.ts:24 node_modules/typescript/lib/lib.es5.d.ts:1077 ---- +___ ### name @@ -94,7 +94,7 @@ node_modules/typescript/lib/lib.es5.d.ts:1077 node_modules/typescript/lib/lib.es5.d.ts:1076 ---- +___ ### stack @@ -108,7 +108,7 @@ node_modules/typescript/lib/lib.es5.d.ts:1076 node_modules/typescript/lib/lib.es5.d.ts:1078 ---- +___ ### prepareStackTrace @@ -126,9 +126,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ##### Parameters -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | +| Name | Type | +| :------ | :------ | +| `err` | `Error` | | `stackTraces` | `CallSite`[] | ##### Returns @@ -143,7 +143,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces node_modules/@types/node/globals.d.ts:28 ---- +___ ### stackTraceLimit @@ -167,9 +167,9 @@ Create .stack property on a target object #### Parameters -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | | `constructorOpt?` | `Function` | #### Returns diff --git a/docs/nevermined-sdk/api-reference/classes/DDOServiceNotFoundError.md b/docs/nevermined-sdk/api-reference/classes/DDOServiceNotFoundError.md index 5d47c9f567..44f562e102 100644 --- a/docs/nevermined-sdk/api-reference/classes/DDOServiceNotFoundError.md +++ b/docs/nevermined-sdk/api-reference/classes/DDOServiceNotFoundError.md @@ -35,10 +35,10 @@ #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `serviceType` | `string` | -| `did?` | `string` | +| `did?` | `string` | #### Returns @@ -50,7 +50,7 @@ #### Defined in -[src/errors/NeverminedErrors.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/errors/NeverminedErrors.ts#L76) +[src/errors/NeverminedErrors.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/errors/NeverminedErrors.ts#L76) ## Properties @@ -66,7 +66,7 @@ node_modules/typescript/lib/lib.es2022.error.d.ts:24 ---- +___ ### message @@ -80,7 +80,7 @@ node_modules/typescript/lib/lib.es2022.error.d.ts:24 node_modules/typescript/lib/lib.es5.d.ts:1077 ---- +___ ### name @@ -94,7 +94,7 @@ node_modules/typescript/lib/lib.es5.d.ts:1077 node_modules/typescript/lib/lib.es5.d.ts:1076 ---- +___ ### stack @@ -108,7 +108,7 @@ node_modules/typescript/lib/lib.es5.d.ts:1076 node_modules/typescript/lib/lib.es5.d.ts:1078 ---- +___ ### prepareStackTrace @@ -126,9 +126,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ##### Parameters -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | +| Name | Type | +| :------ | :------ | +| `err` | `Error` | | `stackTraces` | `CallSite`[] | ##### Returns @@ -143,7 +143,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces node_modules/@types/node/globals.d.ts:28 ---- +___ ### stackTraceLimit @@ -167,9 +167,9 @@ Create .stack property on a target object #### Parameters -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | | `constructorOpt?` | `Function` | #### Returns diff --git a/docs/nevermined-sdk/api-reference/classes/DID.md b/docs/nevermined-sdk/api-reference/classes/DID.md index 681091ea45..381a277f8b 100644 --- a/docs/nevermined-sdk/api-reference/classes/DID.md +++ b/docs/nevermined-sdk/api-reference/classes/DID.md @@ -32,8 +32,8 @@ Decentralized ID. #### Parameters -| Name | Type | -| :--- | :------- | +| Name | Type | +| :------ | :------ | | `id` | `string` | #### Returns @@ -42,7 +42,7 @@ Decentralized ID. #### Defined in -[src/nevermined/DID.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/DID.ts#L84) +[src/nevermined/DID.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/DID.ts#L84) ## Properties @@ -54,7 +54,7 @@ Short ID. #### Defined in -[src/nevermined/DID.ts:82](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/DID.ts#L82) +[src/nevermined/DID.ts:82](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/DID.ts#L82) ## Methods @@ -72,9 +72,9 @@ A string with the prefixed id. #### Defined in -[src/nevermined/DID.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/DID.ts#L92) +[src/nevermined/DID.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/DID.ts#L92) ---- +___ ### getEncoded @@ -90,9 +90,9 @@ A base36 encoded string. #### Defined in -[src/nevermined/DID.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/DID.ts#L75) +[src/nevermined/DID.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/DID.ts#L75) ---- +___ ### getId @@ -108,9 +108,9 @@ A string of the _id_ without the prefix. #### Defined in -[src/nevermined/DID.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/DID.ts#L100) +[src/nevermined/DID.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/DID.ts#L100) ---- +___ ### fromEncoded @@ -120,8 +120,8 @@ Returns a new DID from a base36 encoded string. #### Parameters -| Name | Type | Description | -| :-------- | :------- | :--------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `encoded` | `string` | Base36 encoded string. | #### Returns @@ -132,9 +132,9 @@ Returns a new DID from a base36 encoded string. #### Defined in -[src/nevermined/DID.ts:65](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/DID.ts#L65) +[src/nevermined/DID.ts:65](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/DID.ts#L65) ---- +___ ### generate @@ -150,9 +150,9 @@ Returns a new DID. #### Defined in -[src/nevermined/DID.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/DID.ts#L44) +[src/nevermined/DID.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/DID.ts#L44) ---- +___ ### parse @@ -162,8 +162,8 @@ Parses a DID from a string. #### Parameters -| Name | Type | Description | -| :---------- | :-------------------------- | :------------------------------------------------------------------------------------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `didString` | `string` \| [`DID`](DID.md) | DID in string format or DID instance. The didString can be in did:nv: format or 0x: format. | #### Returns @@ -174,9 +174,9 @@ Parses a DID from a string. #### Defined in -[src/nevermined/DID.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/DID.ts#L14) +[src/nevermined/DID.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/DID.ts#L14) ---- +___ ### parseBigInt @@ -184,10 +184,10 @@ Parses a DID from a string. #### Parameters -| Name | Type | Default value | -| :------ | :------- | :------------ | -| `value` | `any` | `undefined` | -| `radix` | `number` | `36` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `value` | `any` | `undefined` | +| `radix` | `number` | `36` | #### Returns @@ -195,4 +195,4 @@ Parses a DID from a string. #### Defined in -[src/nevermined/DID.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/DID.ts#L48) +[src/nevermined/DID.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/DID.ts#L48) diff --git a/docs/nevermined-sdk/api-reference/classes/DIDRegistry.md b/docs/nevermined-sdk/api-reference/classes/DIDRegistry.md index 6e7ec06c84..94b73465c9 100644 --- a/docs/nevermined-sdk/api-reference/classes/DIDRegistry.md +++ b/docs/nevermined-sdk/api-reference/classes/DIDRegistry.md @@ -94,8 +94,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -108,7 +108,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -122,9 +122,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -136,9 +136,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -150,9 +150,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -164,9 +164,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -178,7 +178,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -196,9 +196,9 @@ ContractBase.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -214,9 +214,9 @@ ContractBase.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -232,9 +232,9 @@ ContractBase.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -250,9 +250,9 @@ ContractBase.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -268,9 +268,9 @@ ContractBase.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -286,9 +286,9 @@ ContractBase.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -304,9 +304,9 @@ ContractBase.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -322,9 +322,9 @@ ContractBase.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -334,69 +334,69 @@ ContractBase.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -404,9 +404,9 @@ ContractBase.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -416,38 +416,38 @@ ContractBase.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -455,7 +455,7 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -465,17 +465,17 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------- | -| `provId` | `string` | -| `did` | `string` | -| `delegateAgentId` | `string` | -| `responsibleAgentId` | `string` | -| `activityId` | `string` | -| `signatureDelegate` | `string` | -| `attributes` | `string` | -| `owner` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `provId` | `string` | +| `did` | `string` | +| `delegateAgentId` | `string` | +| `responsibleAgentId` | `string` | +| `activityId` | `string` | +| `signatureDelegate` | `string` | +| `attributes` | `string` | +| `owner` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -483,9 +483,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/DIDRegistry.ts:552](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L552) +[src/keeper/contracts/DIDRegistry.ts:552](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L552) ---- +___ ### addDidProvenanceDelegate @@ -493,12 +493,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :---------------- | :---------------------------------------------- | -| `did` | `string` | -| `delegateAddress` | `string` | -| `owner` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `delegateAddress` | `string` | +| `owner` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -506,9 +506,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/DIDRegistry.ts:579](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L579) +[src/keeper/contracts/DIDRegistry.ts:579](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L579) ---- +___ ### addProvider @@ -516,12 +516,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :--------- | :---------------------------------------------- | -| `did` | `string` | -| `provider` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `provider` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -529,9 +529,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/DIDRegistry.ts:623](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L623) +[src/keeper/contracts/DIDRegistry.ts:623](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L623) ---- +___ ### burn @@ -539,11 +539,11 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :-------- | :---------------------------------------------- | -| `did` | `string` | -| `amount` | `bigint` | -| `from` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `amount` | `bigint` | +| `from` | [`NvmAccount`](NvmAccount.md) | | `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -552,9 +552,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/DIDRegistry.ts:619](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L619) +[src/keeper/contracts/DIDRegistry.ts:619](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L619) ---- +___ ### call @@ -563,16 +563,16 @@ ContractBase.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -584,9 +584,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### enableAndMintDidNft @@ -598,15 +598,15 @@ Only use if the intention is to register a mintable asset and it was registered #### Parameters -| Name | Type | Description | -| :------------ | :---------------------------------------------- | :-------------------------------------- | -| `did` | `string` | The unique identifier of the asset | -| `cap` | `number` | Max number of editions | -| `royalties` | `number` | Asset royalties in the secondary market | -| `preMint` | `boolean` | If true pre-mints the editions of NFT | -| `owner` | [`NvmAccount`](NvmAccount.md) | Account of the user registering the DID | -| `nftMetadata` | `string` | URL to the metadata describing the NFT | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The unique identifier of the asset | +| `cap` | `number` | Max number of editions | +| `royalties` | `number` | Asset royalties in the secondary market | +| `preMint` | `boolean` | If true pre-mints the editions of NFT | +| `owner` | [`NvmAccount`](NvmAccount.md) | Account of the user registering the DID | +| `nftMetadata` | `string` | URL to the metadata describing the NFT | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | #### Returns @@ -616,9 +616,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:216](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L216) +[src/keeper/contracts/DIDRegistry.ts:216](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L216) ---- +___ ### enableAndMintDidNft721 @@ -630,14 +630,14 @@ Only use if the intention is to register a mintable asset and it was registered #### Parameters -| Name | Type | Description | -| :------------ | :---------------------------------------------- | :-------------------------------------- | -| `did` | `string` | The unique identifier of the asset | -| `royalties` | `number` | Asset royalties in the secondary market | -| `preMint` | `boolean` | If true pre-mints the editions of NFT | -| `owner` | [`NvmAccount`](NvmAccount.md) | Account of the user registering the DID | -| `nftMetadata` | `string` | URL to the metadata describing the NFT | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The unique identifier of the asset | +| `royalties` | `number` | Asset royalties in the secondary market | +| `preMint` | `boolean` | If true pre-mints the editions of NFT | +| `owner` | [`NvmAccount`](NvmAccount.md) | Account of the user registering the DID | +| `nftMetadata` | `string` | URL to the metadata describing the NFT | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | #### Returns @@ -647,29 +647,29 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:246](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L246) +[src/keeper/contracts/DIDRegistry.ts:246](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L246) ---- +___ ### getAttributesByDid -▸ **getAttributesByDid**(`did`): `Promise`\<\{ `checksum`: `string` ; `did`: `string` ; `immutableUrl`: `string` ; `nftInitialized`: `boolean` ; `owner`: `string` ; `providers`: `string`[] ; `royalties`: `bigint` ; `serviceEndpoint`: `string` }\> +▸ **getAttributesByDid**(`did`): `Promise`\<\{ `checksum`: `string` ; `did`: `string` ; `immutableUrl`: `string` ; `nftInitialized`: `boolean` ; `owner`: `string` ; `providers`: `string`[] ; `royalties`: `bigint` ; `serviceEndpoint`: `string` }\> #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns -`Promise`\<\{ `checksum`: `string` ; `did`: `string` ; `immutableUrl`: `string` ; `nftInitialized`: `boolean` ; `owner`: `string` ; `providers`: `string`[] ; `royalties`: `bigint` ; `serviceEndpoint`: `string` }\> +`Promise`\<\{ `checksum`: `string` ; `did`: `string` ; `immutableUrl`: `string` ; `nftInitialized`: `boolean` ; `owner`: `string` ; `providers`: `string`[] ; `royalties`: `bigint` ; `serviceEndpoint`: `string` }\> #### Defined in -[src/keeper/contracts/DIDRegistry.ts:300](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L300) +[src/keeper/contracts/DIDRegistry.ts:300](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L300) ---- +___ ### getAttributesByOwner @@ -677,8 +677,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `owner` | `string` | #### Returns @@ -687,9 +687,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:275](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L275) +[src/keeper/contracts/DIDRegistry.ts:275](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L275) ---- +___ ### getBlockNumberUpdated @@ -697,8 +697,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -707,9 +707,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:266](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L266) +[src/keeper/contracts/DIDRegistry.ts:266](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L266) ---- +___ ### getDIDOwner @@ -717,8 +717,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -727,29 +727,29 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:262](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L262) +[src/keeper/contracts/DIDRegistry.ts:262](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L262) ---- +___ ### getDIDProvenanceEvents -▸ **getDIDProvenanceEvents**(`did`): `Promise`\<\{ `activityId`: `string` ; `agentId`: `string` ; `agentInvolvedId`: `string` ; `attributes?`: `string` ; `blockNumberUpdated`: `number` ; `did`: `string` ; `id`: `string` ; `method`: `number` ; `provId`: `string` ; `relatedDid`: `string` }[]\> +▸ **getDIDProvenanceEvents**(`did`): `Promise`\<\{ `activityId`: `string` ; `agentId`: `string` ; `agentInvolvedId`: `string` ; `attributes?`: `string` ; `blockNumberUpdated`: `number` ; `did`: `string` ; `id`: `string` ; `method`: `number` ; `provId`: `string` ; `relatedDid`: `string` }[]\> #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns -`Promise`\<\{ `activityId`: `string` ; `agentId`: `string` ; `agentInvolvedId`: `string` ; `attributes?`: `string` ; `blockNumberUpdated`: `number` ; `did`: `string` ; `id`: `string` ; `method`: `number` ; `provId`: `string` ; `relatedDid`: `string` }[]\> +`Promise`\<\{ `activityId`: `string` ; `agentId`: `string` ; `agentInvolvedId`: `string` ; `attributes?`: `string` ; `blockNumberUpdated`: `number` ; `did`: `string` ; `id`: `string` ; `method`: `number` ; `provId`: `string` ; `relatedDid`: `string` }[]\> #### Defined in -[src/keeper/contracts/DIDRegistry.ts:371](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L371) +[src/keeper/contracts/DIDRegistry.ts:371](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L371) ---- +___ ### getDIDProvenanceMethodEvents @@ -757,16 +757,16 @@ Contract Receipt #### Type parameters -| Name | Type | -| :--- | :--------------------------------------------------------- | -| `T` | extends [`ProvenanceMethod`](../enums/ProvenanceMethod.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`ProvenanceMethod`](../enums/ProvenanceMethod.md) | #### Parameters -| Name | Type | -| :------- | :------- | -| `did` | `string` | -| `method` | `T` | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `method` | `T` | #### Returns @@ -774,9 +774,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:416](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L416) +[src/keeper/contracts/DIDRegistry.ts:416](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L416) ---- +___ ### getDIDRegister @@ -784,8 +784,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -794,9 +794,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:636](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L636) +[src/keeper/contracts/DIDRegistry.ts:636](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L636) ---- +___ ### getDIDRoyalties @@ -804,8 +804,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -814,9 +814,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:353](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L353) +[src/keeper/contracts/DIDRegistry.ts:353](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L353) ---- +___ ### getFromAddress @@ -824,8 +824,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -838,9 +838,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getNFTInfo @@ -848,8 +848,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -858,9 +858,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:640](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L640) +[src/keeper/contracts/DIDRegistry.ts:640](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L640) ---- +___ ### getPermission @@ -868,9 +868,9 @@ Contract Receipt #### Parameters -| Name | Type | -| :-------- | :------- | -| `did` | `string` | +| Name | Type | +| :------ | :------ | +| `did` | `string` | | `grantee` | `string` | #### Returns @@ -879,29 +879,29 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:357](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L357) +[src/keeper/contracts/DIDRegistry.ts:357](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L357) ---- +___ ### getProvenanceEntry -▸ **getProvenanceEntry**(`provId`): `Promise`\<`undefined` \| \{ `activityId`: `any` ; `agentId`: `any` ; `agentInvolvedId`: `any` ; `blockNumberUpdated`: `any` ; `createdBy`: `any` ; `did`: `any` ; `method`: [`ProvenanceMethod`](../enums/ProvenanceMethod.md) ; `relatedDid`: `any` ; `signatureDelegate`: `any` }\> +▸ **getProvenanceEntry**(`provId`): `Promise`\<`undefined` \| \{ `activityId`: `any` ; `agentId`: `any` ; `agentInvolvedId`: `any` ; `blockNumberUpdated`: `any` ; `createdBy`: `any` ; `did`: `any` ; `method`: [`ProvenanceMethod`](../enums/ProvenanceMethod.md) ; `relatedDid`: `any` ; `signatureDelegate`: `any` }\> #### Parameters -| Name | Type | -| :------- | :------- | +| Name | Type | +| :------ | :------ | | `provId` | `string` | #### Returns -`Promise`\<`undefined` \| \{ `activityId`: `any` ; `agentId`: `any` ; `agentInvolvedId`: `any` ; `blockNumberUpdated`: `any` ; `createdBy`: `any` ; `did`: `any` ; `method`: [`ProvenanceMethod`](../enums/ProvenanceMethod.md) ; `relatedDid`: `any` ; `signatureDelegate`: `any` }\> +`Promise`\<`undefined` \| \{ `activityId`: `any` ; `agentId`: `any` ; `agentInvolvedId`: `any` ; `blockNumberUpdated`: `any` ; `createdBy`: `any` ; `did`: `any` ; `method`: [`ProvenanceMethod`](../enums/ProvenanceMethod.md) ; `relatedDid`: `any` ; `signatureDelegate`: `any` }\> #### Defined in -[src/keeper/contracts/DIDRegistry.ts:465](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L465) +[src/keeper/contracts/DIDRegistry.ts:465](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L465) ---- +___ ### getProvenanceOwner @@ -909,8 +909,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -919,9 +919,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:611](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L611) +[src/keeper/contracts/DIDRegistry.ts:611](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L611) ---- +___ ### getProviders @@ -929,8 +929,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -939,24 +939,24 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:631](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L631) +[src/keeper/contracts/DIDRegistry.ts:631](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L631) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -964,9 +964,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### grantPermission @@ -974,11 +974,11 @@ Contract Receipt #### Parameters -| Name | Type | -| :---------- | :---------------------------------------------- | -| `did` | `string` | -| `grantee` | `string` | -| `owner` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `grantee` | `string` | +| `owner` | [`NvmAccount`](NvmAccount.md) | | `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -987,9 +987,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:326](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L326) +[src/keeper/contracts/DIDRegistry.ts:326](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L326) ---- +___ ### grantRegistryOperatorRole @@ -997,10 +997,10 @@ Contract Receipt #### Parameters -| Name | Type | -| :-------- | :---------------------------------------------- | -| `manager` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `manager` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | | `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1009,9 +1009,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:648](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L648) +[src/keeper/contracts/DIDRegistry.ts:648](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L648) ---- +___ ### hashDID @@ -1019,8 +1019,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `didSeed` | `string` | | `creator` | `string` | @@ -1030,9 +1030,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:644](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L644) +[src/keeper/contracts/DIDRegistry.ts:644](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L644) ---- +___ ### init @@ -1040,11 +1040,11 @@ Contract Receipt #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -1056,9 +1056,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### isDIDProvider @@ -1066,9 +1066,9 @@ Contract Receipt #### Parameters -| Name | Type | -| :--------- | :------- | -| `did` | `string` | +| Name | Type | +| :------ | :------ | +| `did` | `string` | | `provider` | `string` | #### Returns @@ -1077,9 +1077,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:271](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L271) +[src/keeper/contracts/DIDRegistry.ts:271](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L271) ---- +___ ### isProvenanceDelegate @@ -1087,9 +1087,9 @@ Contract Receipt #### Parameters -| Name | Type | -| :---------------- | :------- | -| `did` | `string` | +| Name | Type | +| :------ | :------ | +| `did` | `string` | | `delegateAddress` | `string` | #### Returns @@ -1098,9 +1098,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:607](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L607) +[src/keeper/contracts/DIDRegistry.ts:607](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L607) ---- +___ ### mint @@ -1108,11 +1108,11 @@ Contract Receipt #### Parameters -| Name | Type | -| :-------- | :---------------------------------------------- | -| `did` | `string` | -| `amount` | `bigint` | -| `from` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `amount` | `bigint` | +| `from` | [`NvmAccount`](NvmAccount.md) | | `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1121,9 +1121,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:615](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L615) +[src/keeper/contracts/DIDRegistry.ts:615](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L615) ---- +___ ### registerAttribute @@ -1133,14 +1133,14 @@ It registers a decentralized identifier (aka DID) in the `DIDRegistry` smart con #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :----------------------------------------------------- | -| `did` | `string` | The unique identifier of the asset | -| `checksum` | `string` | Checksum resulted of hash the asset metadata | -| `providers` | `string`[] | List of addresses in charge of interact with the asset | -| `url` | `string` | URL to the metadata in the Metadata/Marketplace API | -| `owner` | [`NvmAccount`](NvmAccount.md) | Account of the user registering the DID | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The unique identifier of the asset | +| `checksum` | `string` | Checksum resulted of hash the asset metadata | +| `providers` | `string`[] | List of addresses in charge of interact with the asset | +| `url` | `string` | URL to the metadata in the Metadata/Marketplace API | +| `owner` | [`NvmAccount`](NvmAccount.md) | Account of the user registering the DID | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | #### Returns @@ -1150,9 +1150,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:38](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L38) +[src/keeper/contracts/DIDRegistry.ts:38](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L38) ---- +___ ### registerDID @@ -1162,16 +1162,16 @@ It registers a decentralized identifier (aka DID) in the `DIDRegistry` smart con #### Parameters -| Name | Type | Default value | Description | -| :------------- | :---------------------------------------------- | :------------ | :------------------------------------------------------------------------------------ | -| `did` | `string` | `undefined` | The unique identifier of the asset | -| `checksum` | `string` | `undefined` | Checksum resulted of hash the asset metadata | -| `providers` | `string`[] | `undefined` | List of addresses in charge of interact with the asset | -| `owner` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user registering the DID | -| `url` | `string` | `undefined` | URL to the metadata in the Metadata/Marketplace API | -| `immutableUrl` | `string` | `''` | Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc | -| `activityId` | `string` | `undefined` | Provenance identifier about the asset registration action | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Transaction additional parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | The unique identifier of the asset | +| `checksum` | `string` | `undefined` | Checksum resulted of hash the asset metadata | +| `providers` | `string`[] | `undefined` | List of addresses in charge of interact with the asset | +| `owner` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user registering the DID | +| `url` | `string` | `undefined` | URL to the metadata in the Metadata/Marketplace API | +| `immutableUrl` | `string` | `''` | Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc | +| `activityId` | `string` | `undefined` | Provenance identifier about the asset registration action | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Transaction additional parameters | #### Returns @@ -1181,9 +1181,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L67) +[src/keeper/contracts/DIDRegistry.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L67) ---- +___ ### registerMintableDID @@ -1193,18 +1193,18 @@ It registers a decentralized identifier (aka DID) in the `DIDRegistry` smart con #### Parameters -| Name | Type | Default value | Description | -| :------------------- | :---------------------------------------------- | :------------ | :------------------------------------------------------------------------------------ | -| `did` | `string` | `undefined` | The unique identifier of the asset | -| `nftContractAddress` | `string` | `undefined` | - | -| `checksum` | `string` | `undefined` | Checksum resulted of hash the asset metadata | -| `providers` | `string`[] | `undefined` | List of addresses in charge of interact with the asset | -| `owner` | [`NvmAccount`](NvmAccount.md) | `undefined` | Address of the user registering the DID | -| `nftAttributes` | [`NFTAttributes`](NFTAttributes.md) | `undefined` | Attributes of the NFT associated to the NFT | -| `url` | `string` | `undefined` | URL to the metadata in the Metadata/Marketplace API | -| `immutableUrl` | `string` | `''` | Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc | -| `activityId` | `string` | `undefined` | Provenance identifier about the asset registration action | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Transaction additional parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | The unique identifier of the asset | +| `nftContractAddress` | `string` | `undefined` | - | +| `checksum` | `string` | `undefined` | Checksum resulted of hash the asset metadata | +| `providers` | `string`[] | `undefined` | List of addresses in charge of interact with the asset | +| `owner` | [`NvmAccount`](NvmAccount.md) | `undefined` | Address of the user registering the DID | +| `nftAttributes` | [`NFTAttributes`](NFTAttributes.md) | `undefined` | Attributes of the NFT associated to the NFT | +| `url` | `string` | `undefined` | URL to the metadata in the Metadata/Marketplace API | +| `immutableUrl` | `string` | `''` | Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc | +| `activityId` | `string` | `undefined` | Provenance identifier about the asset registration action | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Transaction additional parameters | #### Returns @@ -1214,9 +1214,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:99](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L99) +[src/keeper/contracts/DIDRegistry.ts:99](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L99) ---- +___ ### registerMintableDID721 @@ -1226,18 +1226,18 @@ It registers a decentralized identifier (aka DID) in the `DIDRegistry` smart con #### Parameters -| Name | Type | Default value | Description | -| :------------------- | :---------------------------------------------- | :------------ | :------------------------------------------------------------------------------------ | -| `did` | `string` | `undefined` | The unique identifier of the asset | -| `nftContractAddress` | `string` | `undefined` | - | -| `checksum` | `string` | `undefined` | Checksum resulted of hash the asset metadata | -| `providers` | `string`[] | `undefined` | List of addresses in charge of interact with the asset | -| `owner` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user registering the DID | -| `nftAttributes` | [`NFTAttributes`](NFTAttributes.md) | `undefined` | Attributes of the NFT associated to the NFT | -| `url` | `string` | `undefined` | URL to the metadata in the Metadata/Marketplace API | -| `immutableUrl` | `string` | `''` | Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc | -| `activityId` | `string` | `undefined` | Provenance identifier about the asset registration action | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Transaction additional parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | The unique identifier of the asset | +| `nftContractAddress` | `string` | `undefined` | - | +| `checksum` | `string` | `undefined` | Checksum resulted of hash the asset metadata | +| `providers` | `string`[] | `undefined` | List of addresses in charge of interact with the asset | +| `owner` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user registering the DID | +| `nftAttributes` | [`NFTAttributes`](NFTAttributes.md) | `undefined` | Attributes of the NFT associated to the NFT | +| `url` | `string` | `undefined` | URL to the metadata in the Metadata/Marketplace API | +| `immutableUrl` | `string` | `''` | Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc | +| `activityId` | `string` | `undefined` | Provenance identifier about the asset registration action | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Transaction additional parameters | #### Returns @@ -1247,9 +1247,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L145) +[src/keeper/contracts/DIDRegistry.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L145) ---- +___ ### removeDidProvenanceDelegate @@ -1257,12 +1257,12 @@ Contract Receipt #### Parameters -| Name | Type | -| :---------------- | :---------------------------------------------- | -| `did` | `string` | -| `delegateAddress` | `string` | -| `owner` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `delegateAddress` | `string` | +| `owner` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1270,9 +1270,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:593](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L593) +[src/keeper/contracts/DIDRegistry.ts:593](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L593) ---- +___ ### removeProvider @@ -1280,12 +1280,12 @@ Contract Receipt #### Parameters -| Name | Type | -| :--------- | :---------------------------------------------- | -| `did` | `string` | -| `provider` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `provider` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1293,9 +1293,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:627](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L627) +[src/keeper/contracts/DIDRegistry.ts:627](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L627) ---- +___ ### revokePermission @@ -1303,11 +1303,11 @@ Contract Receipt #### Parameters -| Name | Type | -| :---------- | :---------------------------------------------- | -| `did` | `string` | -| `grantee` | `string` | -| `owner` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `grantee` | `string` | +| `owner` | [`NvmAccount`](NvmAccount.md) | | `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1316,9 +1316,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:335](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L335) +[src/keeper/contracts/DIDRegistry.ts:335](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L335) ---- +___ ### send @@ -1326,12 +1326,12 @@ Contract Receipt #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1343,9 +1343,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -1353,12 +1353,12 @@ Contract Receipt #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1370,9 +1370,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setDIDRoyalties @@ -1380,11 +1380,11 @@ Contract Receipt #### Parameters -| Name | Type | -| :---------- | :---------------------------------------------- | -| `did` | `string` | -| `scheme` | `string` | -| `owner` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `scheme` | `string` | +| `owner` | [`NvmAccount`](NvmAccount.md) | | `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1393,9 +1393,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:344](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L344) +[src/keeper/contracts/DIDRegistry.ts:344](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L344) ---- +___ ### setInstanceConfig @@ -1403,8 +1403,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1417,9 +1417,9 @@ Contract Receipt #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1427,8 +1427,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1441,9 +1441,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### transferDIDOwnership @@ -1451,12 +1451,12 @@ Contract Receipt #### Parameters -| Name | Type | -| :---------------- | :---------------------------------------------- | -| `did` | `string` | -| `newOwnerAddress` | `string` | -| `owner` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `newOwnerAddress` | `string` | +| `owner` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1464,9 +1464,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:361](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L361) +[src/keeper/contracts/DIDRegistry.ts:361](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L361) ---- +___ ### updateMetadataUrl @@ -1476,14 +1476,14 @@ It registers a decentralized identifier (aka DID) in the `DIDRegistry` smart con #### Parameters -| Name | Type | Default value | Description | -| :------------- | :---------------------------------------------- | :------------ | :------------------------------------------------------------------------------------ | -| `did` | `string` | `undefined` | The unique identifier of the asset | -| `checksum` | `string` | `undefined` | Checksum resulted of hash the asset metadata | -| `owner` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user registering the DID | -| `url` | `string` | `undefined` | URL to the metadata in the Metadata/Marketplace API | -| `immutableUrl` | `string` | `''` | Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Transaction additional parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | The unique identifier of the asset | +| `checksum` | `string` | `undefined` | Checksum resulted of hash the asset metadata | +| `owner` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user registering the DID | +| `url` | `string` | `undefined` | URL to the metadata in the Metadata/Marketplace API | +| `immutableUrl` | `string` | `''` | Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Transaction additional parameters | #### Returns @@ -1493,9 +1493,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:186](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L186) +[src/keeper/contracts/DIDRegistry.ts:186](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L186) ---- +___ ### used @@ -1503,16 +1503,16 @@ Contract Receipt #### Parameters -| Name | Type | -| :--------------- | :---------------------------------------------- | -| `provId` | `string` | -| `did` | `string` | -| `agentId` | `string` | -| `activityId` | `string` | -| `signatureUsing` | `string` | -| `attributes` | `string` | -| `owner` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `provId` | `string` | +| `did` | `string` | +| `agentId` | `string` | +| `activityId` | `string` | +| `signatureUsing` | `string` | +| `attributes` | `string` | +| `owner` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1520,9 +1520,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:485](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L485) +[src/keeper/contracts/DIDRegistry.ts:485](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L485) ---- +___ ### wasAssociatedWith @@ -1530,15 +1530,15 @@ Contract Receipt #### Parameters -| Name | Type | -| :----------- | :---------------------------------------------- | -| `provId` | `string` | -| `did` | `string` | -| `agentId` | `string` | -| `activityId` | `string` | -| `attributes` | `string` | -| `owner` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `provId` | `string` | +| `did` | `string` | +| `agentId` | `string` | +| `activityId` | `string` | +| `attributes` | `string` | +| `owner` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1546,9 +1546,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:535](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L535) +[src/keeper/contracts/DIDRegistry.ts:535](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L535) ---- +___ ### wasDerivedFrom @@ -1556,16 +1556,16 @@ Contract Receipt #### Parameters -| Name | Type | -| :-------------- | :---------------------------------------------- | -| `provId` | `string` | -| `newEntityDid` | `string` | -| `usedEntityDid` | `string` | -| `agentId` | `string` | -| `activityId` | `string` | -| `attributes` | `string` | -| `owner` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `provId` | `string` | +| `newEntityDid` | `string` | +| `usedEntityDid` | `string` | +| `agentId` | `string` | +| `activityId` | `string` | +| `attributes` | `string` | +| `owner` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1573,9 +1573,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:510](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L510) +[src/keeper/contracts/DIDRegistry.ts:510](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L510) ---- +___ ### getInstance @@ -1583,8 +1583,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1597,9 +1597,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/DIDRegistry.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/DIDRegistry.ts#L21) +[src/keeper/contracts/DIDRegistry.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/DIDRegistry.ts#L21) ---- +___ ### setInstanceConfig @@ -1607,15 +1607,15 @@ Contract Receipt #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1628,4 +1628,4 @@ Contract Receipt #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/DIDSalesTemplate.md b/docs/nevermined-sdk/api-reference/classes/DIDSalesTemplate.md index f3133aaa0c..71d9d8771c 100644 --- a/docs/nevermined-sdk/api-reference/classes/DIDSalesTemplate.md +++ b/docs/nevermined-sdk/api-reference/classes/DIDSalesTemplate.md @@ -91,8 +91,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -105,7 +105,7 @@ #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) ## Properties @@ -119,9 +119,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -133,9 +133,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -147,9 +147,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -161,9 +161,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -175,7 +175,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -193,9 +193,9 @@ BaseTemplate.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -211,9 +211,9 @@ BaseTemplate.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -229,9 +229,9 @@ BaseTemplate.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -247,9 +247,9 @@ BaseTemplate.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -265,9 +265,9 @@ BaseTemplate.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -283,9 +283,9 @@ BaseTemplate.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -301,9 +301,9 @@ BaseTemplate.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -319,9 +319,9 @@ BaseTemplate.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -331,69 +331,69 @@ BaseTemplate.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -401,9 +401,9 @@ BaseTemplate.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -413,38 +413,38 @@ BaseTemplate.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -452,7 +452,7 @@ BaseTemplate.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -462,8 +462,8 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | #### Returns @@ -476,9 +476,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:114](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L114) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:114](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L114) ---- +___ ### agreementId @@ -486,10 +486,10 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `agreementIdSeed` | `string` | -| `creator` | `string` | +| `creator` | `string` | #### Returns @@ -501,9 +501,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L202) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L202) ---- +___ ### call @@ -512,16 +512,16 @@ BaseTemplate.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -533,9 +533,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### conditions @@ -551,9 +551,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/DIDSalesTemplate.ts:31](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/DIDSalesTemplate.ts#L31) +[src/keeper/contracts/templates/DIDSalesTemplate.ts:31](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/DIDSalesTemplate.ts#L31) ---- +___ ### createAgreement @@ -561,16 +561,16 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `extraArgs` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `extraArgs` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -582,9 +582,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L73) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L73) ---- +___ ### createAgreementAndPay @@ -592,21 +592,21 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :--------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `accessConsumer` | `string` | -| `condIdx` | `number` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `bigint`[] | -| `receivers` | `string`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `accessConsumer` | `string` | +| `condIdx` | `number` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -618,9 +618,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L98) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L98) ---- +___ ### createAgreementFromDDO @@ -630,14 +630,14 @@ Create a new agreement using the data of a DDO. #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :---------- | -| `agreementIdSeed` | `string` | - | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `parameters` | `DIDSalesTemplateParams` | | -| `consumer` | [`NvmAccount`](NvmAccount.md) | - | -| `timeOuts?` | `number`[] | - | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementIdSeed` | `string` | - | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `parameters` | `DIDSalesTemplateParams` | | +| `consumer` | [`NvmAccount`](NvmAccount.md) | - | +| `timeOuts?` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | #### Returns @@ -651,9 +651,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L211) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L211) ---- +___ ### createAgreementWithPaymentFromDDO @@ -661,16 +661,16 @@ true if the call was successful. #### Parameters -| Name | Type | -| :----------------- | :------------------------------------------------------------------------------------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | -| `parameters` | `DIDSalesTemplateParams` | -| `consumer` | [`NvmAccount`](NvmAccount.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | -| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | +| Name | Type | +| :------ | :------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `DIDSalesTemplateParams` | +| `consumer` | [`NvmAccount`](NvmAccount.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | #### Returns @@ -682,9 +682,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L240) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L240) ---- +___ ### createService @@ -692,13 +692,13 @@ true if the call was successful. #### Parameters -| Name | Type | -| :------------------ | :---------------------------------------------------------------------------- | -| `publisher` | [`NvmAccount`](NvmAccount.md) | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | -| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | -| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | +| Name | Type | +| :------ | :------ | +| `publisher` | [`NvmAccount`](NvmAccount.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | #### Returns @@ -710,9 +710,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L48) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L48) ---- +___ ### description @@ -728,9 +728,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/DIDSalesTemplate.ts:27](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/DIDSalesTemplate.ts#L27) +[src/keeper/contracts/templates/DIDSalesTemplate.ts:27](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/DIDSalesTemplate.ts#L27) ---- +___ ### extraGen @@ -738,8 +738,8 @@ true if the call was successful. #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | #### Returns @@ -752,9 +752,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) ---- +___ ### getAgreementCreatedEvent @@ -764,8 +764,8 @@ Generates and returns the agreement creation event. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns @@ -780,23 +780,23 @@ Agreement created event. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L450) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L450) ---- +___ ### getAgreementData -▸ **getAgreementData**(`agreementId`): `Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> +▸ **getAgreementData**(`agreementId`): `Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns -`Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> +`Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> #### Inherited from @@ -804,9 +804,9 @@ Agreement created event. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L29) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L29) ---- +___ ### getAgreementIdsFromDDO @@ -816,12 +816,12 @@ Get agreement conditions IDs. #### Parameters -| Name | Type | Description | -| :------------ | :----------------------- | :------------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `DIDSalesTemplateParams` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | Agreement ID. | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `creator` | `string` | - | +| `params` | `DIDSalesTemplateParams` | - | #### Returns @@ -835,25 +835,25 @@ The condition IDs. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L169) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L169) ---- +___ ### getAgreementStatus -▸ **getAgreementStatus**(`agreementId`): `Promise`\<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> +▸ **getAgreementStatus**(`agreementId`): `Promise`\<``false`` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> Returns the status of the conditions. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns -`Promise`\<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> +`Promise`\<``false`` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> The conditions status. @@ -863,9 +863,9 @@ The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L331) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L331) ---- +___ ### getAgreementsForDID @@ -873,8 +873,8 @@ The conditions status. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -887,9 +887,9 @@ The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L476) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L476) ---- +___ ### getConditionTypes @@ -909,9 +909,9 @@ A list of condition addresses. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L137) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L137) ---- +___ ### getConditions @@ -931,9 +931,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L148) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L148) ---- +___ ### getFromAddress @@ -941,8 +941,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -955,9 +955,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getServiceAgreementTemplate @@ -973,9 +973,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/DIDSalesTemplate.ts:89](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/DIDSalesTemplate.ts#L89) +[src/keeper/contracts/templates/DIDSalesTemplate.ts:89](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/DIDSalesTemplate.ts#L89) ---- +___ ### getServiceAgreementTemplateConditionByRef @@ -983,8 +983,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `ref` | `string` | #### Returns @@ -997,9 +997,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L314) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L314) ---- +___ ### getServiceAgreementTemplateConditions @@ -1015,17 +1015,17 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L309) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L309) ---- +___ ### getServiceAgreementTemplateDependencies -▸ **getServiceAgreementTemplateDependencies**(): `Promise`\<\{ `[condition: string]`: `string`[]; }\> +▸ **getServiceAgreementTemplateDependencies**(): `Promise`\<\{ `[condition: string]`: `string`[]; }\> #### Returns -`Promise`\<\{ `[condition: string]`: `string`[]; }\> +`Promise`\<\{ `[condition: string]`: `string`[]; }\> #### Inherited from @@ -1033,24 +1033,24 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L321) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L321) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -1058,9 +1058,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -1068,11 +1068,11 @@ A list of condition contracts. #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -1084,9 +1084,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instanceFromDDO @@ -1094,12 +1094,12 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :---------------- | :----------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `DIDSalesTemplateParams` | +| Name | Type | +| :------ | :------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `parameters` | `DIDSalesTemplateParams` | #### Returns @@ -1111,9 +1111,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/DIDSalesTemplate.ts:41](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/DIDSalesTemplate.ts#L41) +[src/keeper/contracts/templates/DIDSalesTemplate.ts:41](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/DIDSalesTemplate.ts#L41) ---- +___ ### lockConditionIndex @@ -1129,9 +1129,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L57) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L57) ---- +___ ### lockTokens @@ -1139,12 +1139,12 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `tokenAddress` | `any` | +| `amounts` | `any` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1156,9 +1156,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L382) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L382) ---- +___ ### name @@ -1174,9 +1174,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/DIDSalesTemplate.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/DIDSalesTemplate.ts#L24) +[src/keeper/contracts/templates/DIDSalesTemplate.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/DIDSalesTemplate.ts#L24) ---- +___ ### params @@ -1184,8 +1184,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :----------- | :------- | +| Name | Type | +| :------ | :------ | | `receiverId` | `string` | #### Returns @@ -1198,9 +1198,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/DIDSalesTemplate.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/DIDSalesTemplate.ts#L21) +[src/keeper/contracts/templates/DIDSalesTemplate.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/DIDSalesTemplate.ts#L21) ---- +___ ### paramsGen @@ -1210,8 +1210,8 @@ Specialize params #### Parameters -| Name | Type | Description | -| :------- | :------------------------------------------------------ | :----------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | Generic parameters | #### Returns @@ -1224,9 +1224,9 @@ Specialize params #### Defined in -[src/keeper/contracts/templates/DIDSalesTemplate.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/DIDSalesTemplate.ts#L18) +[src/keeper/contracts/templates/DIDSalesTemplate.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/DIDSalesTemplate.ts#L18) ---- +___ ### paymentData @@ -1234,8 +1234,8 @@ Specialize params #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | #### Returns @@ -1248,9 +1248,9 @@ Specialize params #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L61) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L61) ---- +___ ### printAgreementStatus @@ -1260,8 +1260,8 @@ Prints the agreement status. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns @@ -1274,9 +1274,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L418) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L418) ---- +___ ### process @@ -1284,11 +1284,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :---------- | :------------------------------------------------------ | -| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1300,9 +1300,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:126](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L126) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:126](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L126) ---- +___ ### send @@ -1310,12 +1310,12 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1327,9 +1327,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -1337,12 +1337,12 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1354,9 +1354,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### service @@ -1372,9 +1372,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/DIDSalesTemplate.ts:82](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/DIDSalesTemplate.ts#L82) +[src/keeper/contracts/templates/DIDSalesTemplate.ts:82](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/DIDSalesTemplate.ts#L82) ---- +___ ### serviceEndpoint @@ -1390,9 +1390,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L44) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L44) ---- +___ ### setInstanceConfig @@ -1400,8 +1400,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1414,9 +1414,9 @@ Prints the agreement status. #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1424,8 +1424,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1438,9 +1438,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### standardContext @@ -1448,11 +1448,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :-------------- | :-------------- | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `serviceIndex?` | `number` | +| Name | Type | +| :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `serviceIndex?` | `number` | #### Returns @@ -1464,9 +1464,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L189) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L189) ---- +___ ### track @@ -1474,11 +1474,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :----------- | :------------------------------------------------------ | -| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `_from` | [`NvmAccount`](NvmAccount.md) | -| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `_from` | [`NvmAccount`](NvmAccount.md) | +| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1490,9 +1490,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:118](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L118) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:118](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L118) ---- +___ ### validateAgreement @@ -1500,14 +1500,14 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `DIDSalesTemplateParams` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `extra` | `any` | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreement_id` | `string` | +| `did` | `string` | +| `params` | `DIDSalesTemplateParams` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `extra` | `any` | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1519,9 +1519,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L141) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L141) ---- +___ ### getInstance @@ -1529,8 +1529,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1543,9 +1543,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/DIDSalesTemplate.ts:85](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/DIDSalesTemplate.ts#L85) +[src/keeper/contracts/templates/DIDSalesTemplate.ts:85](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/DIDSalesTemplate.ts#L85) ---- +___ ### setInstanceConfig @@ -1553,15 +1553,15 @@ Prints the agreement status. #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1574,4 +1574,4 @@ Prints the agreement status. #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/Dispenser.md b/docs/nevermined-sdk/api-reference/classes/Dispenser.md index 0d7b4048b1..833f8bea3d 100644 --- a/docs/nevermined-sdk/api-reference/classes/Dispenser.md +++ b/docs/nevermined-sdk/api-reference/classes/Dispenser.md @@ -57,8 +57,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -71,7 +71,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -85,9 +85,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -99,9 +99,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -113,9 +113,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -127,9 +127,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -141,7 +141,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -159,9 +159,9 @@ ContractBase.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -177,9 +177,9 @@ ContractBase.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -195,9 +195,9 @@ ContractBase.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -213,9 +213,9 @@ ContractBase.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -231,9 +231,9 @@ ContractBase.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -249,9 +249,9 @@ ContractBase.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -267,9 +267,9 @@ ContractBase.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -285,9 +285,9 @@ ContractBase.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -297,69 +297,69 @@ ContractBase.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -367,9 +367,9 @@ ContractBase.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -379,38 +379,38 @@ ContractBase.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -418,7 +418,7 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -429,16 +429,16 @@ ContractBase.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -450,9 +450,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### getFromAddress @@ -460,8 +460,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -474,24 +474,24 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -499,9 +499,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -509,11 +509,11 @@ ContractBase.walletClient #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -525,9 +525,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### requestTokens @@ -535,10 +535,10 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :---------- | :---------------------------------------------- | -| `amount` | `string` \| `number` \| `bigint` | -| `from` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `amount` | `string` \| `number` \| `bigint` | +| `from` | [`NvmAccount`](NvmAccount.md) | | `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -547,9 +547,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/Dispenser.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Dispenser.ts#L14) +[src/keeper/contracts/Dispenser.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Dispenser.ts#L14) ---- +___ ### send @@ -557,12 +557,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -574,9 +574,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -584,12 +584,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -601,9 +601,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -611,8 +611,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -625,9 +625,9 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -635,8 +635,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -649,9 +649,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -659,8 +659,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -673,9 +673,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/Dispenser.ts:8](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Dispenser.ts#L8) +[src/keeper/contracts/Dispenser.ts:8](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Dispenser.ts#L8) ---- +___ ### setInstanceConfig @@ -683,15 +683,15 @@ ContractBase.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -704,4 +704,4 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/DynamicCreditsOverLimit.md b/docs/nevermined-sdk/api-reference/classes/DynamicCreditsOverLimit.md index 295339f839..214c9fb88b 100644 --- a/docs/nevermined-sdk/api-reference/classes/DynamicCreditsOverLimit.md +++ b/docs/nevermined-sdk/api-reference/classes/DynamicCreditsOverLimit.md @@ -35,8 +35,8 @@ #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `message` | `string` | #### Returns @@ -49,7 +49,7 @@ #### Defined in -[src/errors/NeverminedErrors.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/errors/NeverminedErrors.ts#L44) +[src/errors/NeverminedErrors.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/errors/NeverminedErrors.ts#L44) ## Properties @@ -65,7 +65,7 @@ node_modules/typescript/lib/lib.es2022.error.d.ts:24 ---- +___ ### message @@ -79,7 +79,7 @@ node_modules/typescript/lib/lib.es2022.error.d.ts:24 node_modules/typescript/lib/lib.es5.d.ts:1077 ---- +___ ### name @@ -93,7 +93,7 @@ node_modules/typescript/lib/lib.es5.d.ts:1077 node_modules/typescript/lib/lib.es5.d.ts:1076 ---- +___ ### stack @@ -107,7 +107,7 @@ node_modules/typescript/lib/lib.es5.d.ts:1076 node_modules/typescript/lib/lib.es5.d.ts:1078 ---- +___ ### prepareStackTrace @@ -125,9 +125,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ##### Parameters -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | +| Name | Type | +| :------ | :------ | +| `err` | `Error` | | `stackTraces` | `CallSite`[] | ##### Returns @@ -142,7 +142,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces node_modules/@types/node/globals.d.ts:28 ---- +___ ### stackTraceLimit @@ -166,9 +166,9 @@ Create .stack property on a target object #### Parameters -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | | `constructorOpt?` | `Function` | #### Returns diff --git a/docs/nevermined-sdk/api-reference/classes/DynamicCreditsUnderLimit.md b/docs/nevermined-sdk/api-reference/classes/DynamicCreditsUnderLimit.md index e6aed48aa8..86ddd5827a 100644 --- a/docs/nevermined-sdk/api-reference/classes/DynamicCreditsUnderLimit.md +++ b/docs/nevermined-sdk/api-reference/classes/DynamicCreditsUnderLimit.md @@ -35,8 +35,8 @@ #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `message` | `string` | #### Returns @@ -49,7 +49,7 @@ #### Defined in -[src/errors/NeverminedErrors.ts:50](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/errors/NeverminedErrors.ts#L50) +[src/errors/NeverminedErrors.ts:50](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/errors/NeverminedErrors.ts#L50) ## Properties @@ -65,7 +65,7 @@ node_modules/typescript/lib/lib.es2022.error.d.ts:24 ---- +___ ### message @@ -79,7 +79,7 @@ node_modules/typescript/lib/lib.es2022.error.d.ts:24 node_modules/typescript/lib/lib.es5.d.ts:1077 ---- +___ ### name @@ -93,7 +93,7 @@ node_modules/typescript/lib/lib.es5.d.ts:1077 node_modules/typescript/lib/lib.es5.d.ts:1076 ---- +___ ### stack @@ -107,7 +107,7 @@ node_modules/typescript/lib/lib.es5.d.ts:1076 node_modules/typescript/lib/lib.es5.d.ts:1078 ---- +___ ### prepareStackTrace @@ -125,9 +125,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ##### Parameters -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | +| Name | Type | +| :------ | :------ | +| `err` | `Error` | | `stackTraces` | `CallSite`[] | ##### Returns @@ -142,7 +142,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces node_modules/@types/node/globals.d.ts:28 ---- +___ ### stackTraceLimit @@ -166,9 +166,9 @@ Create .stack property on a target object #### Parameters -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | | `constructorOpt?` | `Function` | #### Returns diff --git a/docs/nevermined-sdk/api-reference/classes/EscrowComputeExecutionTemplate.md b/docs/nevermined-sdk/api-reference/classes/EscrowComputeExecutionTemplate.md index 86f19c2ed1..35644c34ba 100644 --- a/docs/nevermined-sdk/api-reference/classes/EscrowComputeExecutionTemplate.md +++ b/docs/nevermined-sdk/api-reference/classes/EscrowComputeExecutionTemplate.md @@ -92,8 +92,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -106,7 +106,7 @@ #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) ## Properties @@ -120,9 +120,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -134,9 +134,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -148,9 +148,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -162,9 +162,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -176,7 +176,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -194,9 +194,9 @@ BaseTemplate.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -212,9 +212,9 @@ BaseTemplate.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -230,9 +230,9 @@ BaseTemplate.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -248,9 +248,9 @@ BaseTemplate.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -266,9 +266,9 @@ BaseTemplate.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -284,9 +284,9 @@ BaseTemplate.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -302,9 +302,9 @@ BaseTemplate.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -320,9 +320,9 @@ BaseTemplate.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -332,69 +332,69 @@ BaseTemplate.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -402,9 +402,9 @@ BaseTemplate.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -414,38 +414,38 @@ BaseTemplate.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -453,7 +453,7 @@ BaseTemplate.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -463,8 +463,8 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | #### Returns @@ -477,9 +477,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:114](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L114) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:114](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L114) ---- +___ ### agreementId @@ -487,10 +487,10 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `agreementIdSeed` | `string` | -| `creator` | `string` | +| `creator` | `string` | #### Returns @@ -502,9 +502,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L202) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L202) ---- +___ ### call @@ -513,16 +513,16 @@ BaseTemplate.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -534,9 +534,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### conditions @@ -552,9 +552,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:125](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L125) +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:125](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L125) ---- +___ ### createAgreement @@ -562,16 +562,16 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `extraArgs` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `extraArgs` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -583,9 +583,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L73) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L73) ---- +___ ### createAgreementAndPay @@ -593,21 +593,21 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :--------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `accessConsumer` | `string` | -| `condIdx` | `number` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `bigint`[] | -| `receivers` | `string`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `accessConsumer` | `string` | +| `condIdx` | `number` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -619,9 +619,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L98) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L98) ---- +___ ### createAgreementFromDDO @@ -631,14 +631,14 @@ Create a new agreement using the data of a DDO. #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :---------- | -| `agreementIdSeed` | `string` | - | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `parameters` | `EscrowComputeExecutionParams` | | -| `consumer` | [`NvmAccount`](NvmAccount.md) | - | -| `timeOuts?` | `number`[] | - | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementIdSeed` | `string` | - | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `parameters` | `EscrowComputeExecutionParams` | | +| `consumer` | [`NvmAccount`](NvmAccount.md) | - | +| `timeOuts?` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | #### Returns @@ -652,9 +652,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L211) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L211) ---- +___ ### createAgreementWithPaymentFromDDO @@ -662,16 +662,16 @@ true if the call was successful. #### Parameters -| Name | Type | -| :----------------- | :------------------------------------------------------------------------------------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | -| `parameters` | `EscrowComputeExecutionParams` | -| `consumer` | [`NvmAccount`](NvmAccount.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | -| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | +| Name | Type | +| :------ | :------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `EscrowComputeExecutionParams` | +| `consumer` | [`NvmAccount`](NvmAccount.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | #### Returns @@ -683,9 +683,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L240) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L240) ---- +___ ### createService @@ -693,13 +693,13 @@ true if the call was successful. #### Parameters -| Name | Type | -| :------------------ | :---------------------------------------------------------------------------- | -| `publisher` | [`NvmAccount`](NvmAccount.md) | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | -| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | -| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | +| Name | Type | +| :------ | :------ | +| `publisher` | [`NvmAccount`](NvmAccount.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | #### Returns @@ -711,9 +711,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L48) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L48) ---- +___ ### description @@ -729,9 +729,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:38](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L38) +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:38](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L38) ---- +___ ### extraGen @@ -739,8 +739,8 @@ true if the call was successful. #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | #### Returns @@ -753,9 +753,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) ---- +___ ### getAgreementCreatedEvent @@ -765,8 +765,8 @@ Generates and returns the agreement creation event. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns @@ -781,23 +781,23 @@ Agreement created event. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L450) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L450) ---- +___ ### getAgreementData -▸ **getAgreementData**(`agreementId`): `Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> +▸ **getAgreementData**(`agreementId`): `Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns -`Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> +`Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> #### Inherited from @@ -805,9 +805,9 @@ Agreement created event. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L29) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L29) ---- +___ ### getAgreementIdsFromDDO @@ -817,12 +817,12 @@ Get agreement conditions IDs. #### Parameters -| Name | Type | Description | -| :------------ | :----------------------------- | :------------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `EscrowComputeExecutionParams` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | Agreement ID. | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `creator` | `string` | - | +| `params` | `EscrowComputeExecutionParams` | - | #### Returns @@ -836,25 +836,25 @@ The condition IDs. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L169) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L169) ---- +___ ### getAgreementStatus -▸ **getAgreementStatus**(`agreementId`): `Promise`\<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> +▸ **getAgreementStatus**(`agreementId`): `Promise`\<``false`` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> Returns the status of the conditions. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns -`Promise`\<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> +`Promise`\<``false`` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> The conditions status. @@ -864,9 +864,9 @@ The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L331) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L331) ---- +___ ### getAgreementsForDID @@ -874,8 +874,8 @@ The conditions status. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -888,9 +888,9 @@ The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L476) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L476) ---- +___ ### getConditionTypes @@ -910,9 +910,9 @@ A list of condition addresses. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L137) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L137) ---- +___ ### getConditions @@ -932,9 +932,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L148) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L148) ---- +___ ### getFromAddress @@ -942,8 +942,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -956,9 +956,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getServiceAgreementTemplate @@ -968,16 +968,16 @@ A list of condition contracts. `Object` -| Name | Type | -| :------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `conditionDependency` | \{ `escrowPaymentCondition`: `string`[] ; `lockPayment`: `never`[] = []; `serviceExecution`: `never`[] = [] } | -| `conditionDependency.escrowPaymentCondition` | `string`[] | -| `conditionDependency.lockPayment` | `never`[] | -| `conditionDependency.serviceExecution` | `never`[] | -| `conditions` | \{ `contractName`: `string` = 'LockPaymentCondition'; `events`: \{ `actorType`: `string` = 'publisher'; `handler`: \{ `functionName`: `string` = 'fulfillAccessCondition'; `moduleName`: `string` = 'lockPaymentCondition'; `version`: `string` = '0.1' } ; `name`: `string` = 'Fulfilled' }[] ; `functionName`: `string` = 'fulfill'; `name`: `string` = 'lockPayment'; `parameters`: (\{ `name`: `string` = '\_did'; `type`: `string` = 'bytes32'; `value`: `string` = '' } \| \{ `name`: `string` = '\_amounts'; `type`: `string` = 'uint256[]'; `value`: `never`[] = [] })[] ; `timelock`: `number` = 0; `timeout`: `number` = 0 }[] | -| `contractName` | `string` | -| `events` | \{ `actorType`: `string` = 'consumer'; `handler`: \{ `functionName`: `string` = 'fulfillLockPaymentCondition'; `moduleName`: `string` = 'serviceExecutionTemplate'; `version`: `string` = '0.1' } ; `name`: `string` = 'AgreementCreated' }[] | -| `fulfillmentOrder` | `string`[] | +| Name | Type | +| :------ | :------ | +| `conditionDependency` | \{ `escrowPaymentCondition`: `string`[] ; `lockPayment`: `never`[] = []; `serviceExecution`: `never`[] = [] } | +| `conditionDependency.escrowPaymentCondition` | `string`[] | +| `conditionDependency.lockPayment` | `never`[] | +| `conditionDependency.serviceExecution` | `never`[] | +| `conditions` | \{ `contractName`: `string` = 'LockPaymentCondition'; `events`: \{ `actorType`: `string` = 'publisher'; `handler`: \{ `functionName`: `string` = 'fulfillAccessCondition'; `moduleName`: `string` = 'lockPaymentCondition'; `version`: `string` = '0.1' } ; `name`: `string` = 'Fulfilled' }[] ; `functionName`: `string` = 'fulfill'; `name`: `string` = 'lockPayment'; `parameters`: (\{ `name`: `string` = '\_did'; `type`: `string` = 'bytes32'; `value`: `string` = '' } \| \{ `name`: `string` = '\_amounts'; `type`: `string` = 'uint256[]'; `value`: `never`[] = [] })[] ; `timelock`: `number` = 0; `timeout`: `number` = 0 }[] | +| `contractName` | `string` | +| `events` | \{ `actorType`: `string` = 'consumer'; `handler`: \{ `functionName`: `string` = 'fulfillLockPaymentCondition'; `moduleName`: `string` = 'serviceExecutionTemplate'; `version`: `string` = '0.1' } ; `name`: `string` = 'AgreementCreated' }[] | +| `fulfillmentOrder` | `string`[] | #### Overrides @@ -985,9 +985,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:89](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L89) +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:89](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L89) ---- +___ ### getServiceAgreementTemplateConditionByRef @@ -995,8 +995,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `ref` | `string` | #### Returns @@ -1009,9 +1009,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L314) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L314) ---- +___ ### getServiceAgreementTemplateConditions @@ -1027,17 +1027,17 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L309) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L309) ---- +___ ### getServiceAgreementTemplateDependencies -▸ **getServiceAgreementTemplateDependencies**(): `Promise`\<\{ `[condition: string]`: `string`[]; }\> +▸ **getServiceAgreementTemplateDependencies**(): `Promise`\<\{ `[condition: string]`: `string`[]; }\> #### Returns -`Promise`\<\{ `[condition: string]`: `string`[]; }\> +`Promise`\<\{ `[condition: string]`: `string`[]; }\> #### Inherited from @@ -1045,24 +1045,24 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L321) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L321) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -1070,9 +1070,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -1080,11 +1080,11 @@ A list of condition contracts. #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -1096,9 +1096,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instanceFromDDO @@ -1106,12 +1106,12 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :---------------- | :----------------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `EscrowComputeExecutionParams` | +| Name | Type | +| :------ | :------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `parameters` | `EscrowComputeExecutionParams` | #### Returns @@ -1123,9 +1123,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:131](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L131) +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:131](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L131) ---- +___ ### lockConditionIndex @@ -1141,9 +1141,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L57) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L57) ---- +___ ### lockTokens @@ -1151,12 +1151,12 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `tokenAddress` | `any` | +| `amounts` | `any` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1168,9 +1168,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L382) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L382) ---- +___ ### name @@ -1186,9 +1186,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:35](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L35) +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:35](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L35) ---- +___ ### params @@ -1196,8 +1196,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :--------- | :---------------------------- | +| Name | Type | +| :------ | :------ | | `consumer` | [`NvmAccount`](NvmAccount.md) | #### Returns @@ -1210,9 +1210,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:121](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L121) +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:121](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L121) ---- +___ ### paramsGen @@ -1222,8 +1222,8 @@ Specialize params #### Parameters -| Name | Type | Description | -| :------- | :------------------------------------------------------ | :----------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | Generic parameters | #### Returns @@ -1236,9 +1236,9 @@ Specialize params #### Defined in -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L21) +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L21) ---- +___ ### paymentData @@ -1246,8 +1246,8 @@ Specialize params #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | #### Returns @@ -1260,9 +1260,9 @@ Specialize params #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L61) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L61) ---- +___ ### printAgreementStatus @@ -1272,8 +1272,8 @@ Prints the agreement status. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns @@ -1286,9 +1286,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L418) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L418) ---- +___ ### process @@ -1296,11 +1296,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :---------- | :------------------------------------------------------ | -| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1312,23 +1312,23 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:126](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L126) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:126](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L126) ---- +___ ### providerConfig -▸ **providerConfig**(): `Promise`\<\{ `description`: `string` = ''; `environment`: \{ `cluster`: \{ `type`: `string` = 'Kubernetes'; `url`: `string` = 'http://10.0.0.17/xxx' } ; `supportedContainers`: \{ `checksum`: `string` = 'sha256:cb57ecfa6ebbefd8ffc7f75c0f00e57a7fa739578a429b6f72a0df19315deadc'; `image`: `string` = 'tensorflow/tensorflow'; `tag`: `string` = 'latest' }[] ; `supportedServers`: \{ `cpu`: `string` = '16'; `disk`: `string` = '160gb'; `gpu`: `string` = '0'; `maxExecutionTime`: `number` = 86400; `memory`: `string` = '128gb'; `price`: `string` = '50'; `serverId`: `string` = '1'; `serverType`: `string` = 'xlsize' }[] } ; `type`: `string` = 'Azure' }\> +▸ **providerConfig**(): `Promise`\<\{ `description`: `string` = ''; `environment`: \{ `cluster`: \{ `type`: `string` = 'Kubernetes'; `url`: `string` = 'http://10.0.0.17/xxx' } ; `supportedContainers`: \{ `checksum`: `string` = 'sha256:cb57ecfa6ebbefd8ffc7f75c0f00e57a7fa739578a429b6f72a0df19315deadc'; `image`: `string` = 'tensorflow/tensorflow'; `tag`: `string` = 'latest' }[] ; `supportedServers`: \{ `cpu`: `string` = '16'; `disk`: `string` = '160gb'; `gpu`: `string` = '0'; `maxExecutionTime`: `number` = 86400; `memory`: `string` = '128gb'; `price`: `string` = '50'; `serverId`: `string` = '1'; `serverType`: `string` = 'xlsize' }[] } ; `type`: `string` = 'Azure' }\> #### Returns -`Promise`\<\{ `description`: `string` = ''; `environment`: \{ `cluster`: \{ `type`: `string` = 'Kubernetes'; `url`: `string` = 'http://10.0.0.17/xxx' } ; `supportedContainers`: \{ `checksum`: `string` = 'sha256:cb57ecfa6ebbefd8ffc7f75c0f00e57a7fa739578a429b6f72a0df19315deadc'; `image`: `string` = 'tensorflow/tensorflow'; `tag`: `string` = 'latest' }[] ; `supportedServers`: \{ `cpu`: `string` = '16'; `disk`: `string` = '160gb'; `gpu`: `string` = '0'; `maxExecutionTime`: `number` = 86400; `memory`: `string` = '128gb'; `price`: `string` = '50'; `serverId`: `string` = '1'; `serverType`: `string` = 'xlsize' }[] } ; `type`: `string` = 'Azure' }\> +`Promise`\<\{ `description`: `string` = ''; `environment`: \{ `cluster`: \{ `type`: `string` = 'Kubernetes'; `url`: `string` = 'http://10.0.0.17/xxx' } ; `supportedContainers`: \{ `checksum`: `string` = 'sha256:cb57ecfa6ebbefd8ffc7f75c0f00e57a7fa739578a429b6f72a0df19315deadc'; `image`: `string` = 'tensorflow/tensorflow'; `tag`: `string` = 'latest' }[] ; `supportedServers`: \{ `cpu`: `string` = '16'; `disk`: `string` = '160gb'; `gpu`: `string` = '0'; `maxExecutionTime`: `number` = 86400; `memory`: `string` = '128gb'; `price`: `string` = '50'; `serverId`: `string` = '1'; `serverType`: `string` = 'xlsize' }[] } ; `type`: `string` = 'Azure' }\> #### Defined in -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:42](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L42) +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:42](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L42) ---- +___ ### send @@ -1336,12 +1336,12 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1353,9 +1353,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -1363,12 +1363,12 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1380,9 +1380,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### service @@ -1398,9 +1398,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:117](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L117) +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:117](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L117) ---- +___ ### serviceEndpoint @@ -1416,9 +1416,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L44) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L44) ---- +___ ### setInstanceConfig @@ -1426,8 +1426,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1440,9 +1440,9 @@ Prints the agreement status. #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1450,8 +1450,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1464,9 +1464,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### standardContext @@ -1474,11 +1474,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :-------------- | :-------------- | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `serviceIndex?` | `number` | +| Name | Type | +| :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `serviceIndex?` | `number` | #### Returns @@ -1490,9 +1490,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L189) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L189) ---- +___ ### track @@ -1500,11 +1500,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :----------- | :------------------------------------------------------ | -| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `_from` | [`NvmAccount`](NvmAccount.md) | -| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `_from` | [`NvmAccount`](NvmAccount.md) | +| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1516,9 +1516,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:118](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L118) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:118](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L118) ---- +___ ### validateAgreement @@ -1526,14 +1526,14 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `EscrowComputeExecutionParams` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `extra` | `any` | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreement_id` | `string` | +| `did` | `string` | +| `params` | `EscrowComputeExecutionParams` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `extra` | `any` | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1545,9 +1545,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L141) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L141) ---- +___ ### getInstance @@ -1555,8 +1555,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1569,9 +1569,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L26) +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L26) ---- +___ ### setInstanceConfig @@ -1579,15 +1579,15 @@ Prints the agreement status. #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1600,4 +1600,4 @@ Prints the agreement status. #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/EscrowPaymentCondition.md b/docs/nevermined-sdk/api-reference/classes/EscrowPaymentCondition.md index f9d1d3624b..da576f6ff8 100644 --- a/docs/nevermined-sdk/api-reference/classes/EscrowPaymentCondition.md +++ b/docs/nevermined-sdk/api-reference/classes/EscrowPaymentCondition.md @@ -72,8 +72,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -86,7 +86,7 @@ ProviderCondition\.constructor #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -100,9 +100,9 @@ ProviderCondition.address #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -114,9 +114,9 @@ ProviderCondition.contract #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -128,9 +128,9 @@ ProviderCondition.contractName #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -142,9 +142,9 @@ ProviderCondition.events #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -156,7 +156,7 @@ ProviderCondition.version #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -174,9 +174,9 @@ ProviderCondition.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -192,9 +192,9 @@ ProviderCondition.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -210,9 +210,9 @@ ProviderCondition.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -228,9 +228,9 @@ ProviderCondition.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -246,9 +246,9 @@ ProviderCondition.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -264,9 +264,9 @@ ProviderCondition.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -282,9 +282,9 @@ ProviderCondition.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -300,9 +300,9 @@ ProviderCondition.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -312,69 +312,69 @@ ProviderCondition.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -382,9 +382,9 @@ ProviderCondition.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -394,38 +394,38 @@ ProviderCondition.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -433,7 +433,7 @@ ProviderCondition.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -443,11 +443,11 @@ ProviderCondition.walletClient #### Parameters -| Name | Type | -| :------------ | :---------------------------------------------- | -| `conditionId` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `conditionId` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -459,9 +459,9 @@ ProviderCondition.abortByTimeOut #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L75) +[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L75) ---- +___ ### call @@ -470,16 +470,16 @@ ProviderCondition.abortByTimeOut #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -491,9 +491,9 @@ ProviderCondition.call #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### fulfill @@ -501,19 +501,19 @@ ProviderCondition.call #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `amounts` | `bigint`[] | -| `receivers` | `string`[] | -| `returnAddress` | `string` | -| `lockPaymentAddress` | `string` | -| `tokenAddress` | `string` | -| `lockCondition` | `string` | -| `releaseCondition` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `returnAddress` | `string` | +| `lockPaymentAddress` | `string` | +| `tokenAddress` | `string` | +| `lockCondition` | `string` | +| `releaseCondition` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -525,9 +525,9 @@ ProviderCondition.fulfill #### Defined in -[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L57) +[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L57) ---- +___ ### fulfillInstance @@ -535,13 +535,13 @@ ProviderCondition.fulfill #### Parameters -| Name | Type | Default value | -| :----------------- | :-------------------------------------------------------- | :------------ | -| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -553,9 +553,9 @@ ProviderCondition.fulfillInstance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L139) +[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L139) ---- +___ ### fulfillPlain @@ -563,13 +563,13 @@ ProviderCondition.fulfillInstance #### Parameters -| Name | Type | Default value | -| :------------ | :-------------------------------------------------------- | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -581,9 +581,9 @@ ProviderCondition.fulfillPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L47) +[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L47) ---- +___ ### fulfillWithNode @@ -591,12 +591,12 @@ ProviderCondition.fulfillPlain #### Parameters -| Name | Type | -| :----------------- | :----------------------------------------------------- | -| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | -| `additionalParams` | `Record`\<`string`, `unknown`\> | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | +| `additionalParams` | `Record`\<`string`, `unknown`\> | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -608,9 +608,9 @@ ProviderCondition.fulfillWithNode #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L183) +[src/keeper/contracts/conditions/Condition.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L183) ---- +___ ### generateId @@ -618,10 +618,10 @@ ProviderCondition.fulfillWithNode #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -633,9 +633,9 @@ ProviderCondition.generateId #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L61) +[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L61) ---- +___ ### generateIdHash @@ -643,10 +643,10 @@ ProviderCondition.generateId #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `...values` | `any`[] | +| `...values` | `any`[] | #### Returns @@ -658,9 +658,9 @@ ProviderCondition.generateIdHash #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L57) +[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L57) ---- +___ ### generateIdWithSeed @@ -668,10 +668,10 @@ ProviderCondition.generateIdHash #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -683,9 +683,9 @@ ProviderCondition.generateIdWithSeed #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L65) +[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L65) ---- +___ ### getConditionFulfilledEvent @@ -693,8 +693,8 @@ ProviderCondition.generateIdWithSeed #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns @@ -707,9 +707,9 @@ ProviderCondition.getConditionFulfilledEvent #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L79) +[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L79) ---- +___ ### getFromAddress @@ -717,8 +717,8 @@ ProviderCondition.getConditionFulfilledEvent #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -731,24 +731,24 @@ ProviderCondition.getFromAddress #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -756,9 +756,9 @@ ProviderCondition.getTransactionLogs #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### hashValues @@ -766,8 +766,8 @@ ProviderCondition.getTransactionLogs #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -780,9 +780,9 @@ ProviderCondition.hashValues #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L116) +[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L116) ---- +___ ### hashValuesPlain @@ -790,8 +790,8 @@ ProviderCondition.hashValues #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -804,9 +804,9 @@ ProviderCondition.hashValuesPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L122) +[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L122) ---- +___ ### init @@ -814,11 +814,11 @@ ProviderCondition.hashValuesPlain #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -830,9 +830,9 @@ ProviderCondition.init #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instance @@ -840,10 +840,10 @@ ProviderCondition.init #### Parameters -| Name | Type | -| :------------ | :------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | #### Returns @@ -855,9 +855,9 @@ ProviderCondition.instance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L163) +[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L163) ---- +___ ### instanceFromDDO @@ -865,11 +865,11 @@ ProviderCondition.instance #### Parameters -| Name | Type | -| :------------ | :-------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `EscrowPaymentConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `ctx` | `EscrowPaymentConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | #### Returns @@ -881,9 +881,9 @@ ProviderCondition.instanceFromDDO #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L131) +[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L131) ---- +___ ### nodeMethod @@ -899,9 +899,9 @@ ProviderCondition.nodeMethod #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L200) +[src/keeper/contracts/conditions/Condition.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L200) ---- +___ ### params @@ -909,16 +909,16 @@ ProviderCondition.nodeMethod #### Parameters -| Name | Type | -| :----------------- | :--------- | -| `did` | `string` | -| `amounts` | `bigint`[] | -| `receivers` | `string`[] | -| `returnAddress` | `string` | -| `sender` | `string` | -| `tokenAddress` | `string` | -| `lockCondition` | `string` | -| `releaseCondition` | `string` | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `returnAddress` | `string` | +| `sender` | `string` | +| `tokenAddress` | `string` | +| `lockCondition` | `string` | +| `releaseCondition` | `string` | #### Returns @@ -930,9 +930,9 @@ ProviderCondition.params #### Defined in -[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L18) +[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L18) ---- +___ ### paramsFromDDO @@ -940,11 +940,11 @@ ProviderCondition.params #### Parameters -| Name | Type | -| :--------------- | :------------------------------------------------------------------ | -| `«destructured»` | `EscrowPaymentConditionContext` | -| `access` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md) | -| `lock` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md) | +| Name | Type | +| :------ | :------ | +| `«destructured»` | `EscrowPaymentConditionContext` | +| `access` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md) | +| `lock` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md) | #### Returns @@ -956,9 +956,9 @@ ProviderCondition.paramsFromDDO #### Defined in -[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:37](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L37) +[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:37](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L37) ---- +___ ### send @@ -966,12 +966,12 @@ ProviderCondition.paramsFromDDO #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -983,9 +983,9 @@ ProviderCondition.send #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -993,12 +993,12 @@ ProviderCondition.send #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1010,9 +1010,9 @@ ProviderCondition.sendFrom #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -1020,8 +1020,8 @@ ProviderCondition.sendFrom #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1034,9 +1034,9 @@ ProviderCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1044,8 +1044,8 @@ ProviderCondition.setInstanceConfig #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1058,9 +1058,9 @@ ProviderCondition.someLog #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -1068,8 +1068,8 @@ ProviderCondition.someLog #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1082,9 +1082,9 @@ ProviderCondition.getInstance #### Defined in -[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L14) +[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L14) ---- +___ ### setInstanceConfig @@ -1092,15 +1092,15 @@ ProviderCondition.getInstance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1113,4 +1113,4 @@ ProviderCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/EthSignJWT.md b/docs/nevermined-sdk/api-reference/classes/EthSignJWT.md index a773bca5dd..3e82d9befa 100644 --- a/docs/nevermined-sdk/api-reference/classes/EthSignJWT.md +++ b/docs/nevermined-sdk/api-reference/classes/EthSignJWT.md @@ -43,8 +43,8 @@ #### Parameters -| Name | Type | Description | -| :-------- | :----------- | :------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `payload` | `JWTPayload` | The JWT Claims Set object. | #### Returns @@ -73,7 +73,7 @@ SignJWT.\_payload node_modules/jose/dist/types/jwt/produce.d.ts:4 ---- +___ ### protectedHeader @@ -81,7 +81,7 @@ node_modules/jose/dist/types/jwt/produce.d.ts:4 #### Defined in -[src/nevermined/utils/JwtUtils.ts:12](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L12) +[src/nevermined/utils/JwtUtils.ts:12](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L12) ## Methods @@ -91,8 +91,8 @@ node_modules/jose/dist/types/jwt/produce.d.ts:4 #### Parameters -| Name | Type | -| :------ | :----------------------- | +| Name | Type | +| :------ | :------ | | `input` | `string` \| `Uint8Array` | #### Returns @@ -101,9 +101,9 @@ node_modules/jose/dist/types/jwt/produce.d.ts:4 #### Defined in -[src/nevermined/utils/JwtUtils.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L91) +[src/nevermined/utils/JwtUtils.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L91) ---- +___ ### concat @@ -111,8 +111,8 @@ node_modules/jose/dist/types/jwt/produce.d.ts:4 #### Parameters -| Name | Type | -| :----------- | :------------- | +| Name | Type | +| :------ | :------ | | `...buffers` | `Uint8Array`[] | #### Returns @@ -121,9 +121,9 @@ node_modules/jose/dist/types/jwt/produce.d.ts:4 #### Defined in -[src/nevermined/utils/JwtUtils.ts:99](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L99) +[src/nevermined/utils/JwtUtils.ts:99](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L99) ---- +___ ### ethSign @@ -131,11 +131,11 @@ node_modules/jose/dist/types/jwt/produce.d.ts:4 #### Parameters -| Name | Type | -| :--------------- | :------------------------------------------ | -| `signatureUtils` | [`SignatureUtils`](SignatureUtils.md) | -| `account` | [`NvmAccount`](NvmAccount.md) | -| `eip712Data?` | [`Eip712Data`](../interfaces/Eip712Data.md) | +| Name | Type | +| :------ | :------ | +| `signatureUtils` | [`SignatureUtils`](SignatureUtils.md) | +| `account` | [`NvmAccount`](NvmAccount.md) | +| `eip712Data?` | [`Eip712Data`](../interfaces/Eip712Data.md) | #### Returns @@ -143,9 +143,9 @@ node_modules/jose/dist/types/jwt/produce.d.ts:4 #### Defined in -[src/nevermined/utils/JwtUtils.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L19) +[src/nevermined/utils/JwtUtils.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L19) ---- +___ ### setAudience @@ -155,8 +155,8 @@ Set "aud" (Audience) Claim. #### Parameters -| Name | Type | Description | -| :--------- | :--------------------- | :--------------------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `audience` | `string` \| `string`[] | "aud" (Audience) Claim value to set on the JWT Claims Set. | #### Returns @@ -171,7 +171,7 @@ SignJWT.setAudience node_modules/jose/dist/types/jwt/produce.d.ts:24 ---- +___ ### setExpirationTime @@ -181,8 +181,8 @@ Set "exp" (Expiration Time) Claim. #### Parameters -| Name | Type | Description | -| :------ | :------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `input` | `string` \| `number` | "exp" (Expiration Time) Claim value to set on the JWT Claims Set. When number is passed that is used as a value, when string is passed it is resolved to a time span and added to the current timestamp. | #### Returns @@ -197,7 +197,7 @@ SignJWT.setExpirationTime node_modules/jose/dist/types/jwt/produce.d.ts:46 ---- +___ ### setIssuedAt @@ -207,8 +207,8 @@ Set "iat" (Issued At) Claim. #### Parameters -| Name | Type | Description | -| :------- | :------- | :---------------------------------------------------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `input?` | `number` | "iat" (Issued At) Claim value to set on the JWT Claims Set. Default is current timestamp. | #### Returns @@ -223,7 +223,7 @@ SignJWT.setIssuedAt node_modules/jose/dist/types/jwt/produce.d.ts:53 ---- +___ ### setIssuer @@ -233,8 +233,8 @@ Set "iss" (Issuer) Claim. #### Parameters -| Name | Type | Description | -| :------- | :------- | :------------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `issuer` | `string` | "Issuer" Claim value to set on the JWT Claims Set. | #### Returns @@ -249,7 +249,7 @@ SignJWT.setIssuer node_modules/jose/dist/types/jwt/produce.d.ts:12 ---- +___ ### setJti @@ -259,8 +259,8 @@ Set "jti" (JWT ID) Claim. #### Parameters -| Name | Type | Description | -| :------ | :------- | :------------------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `jwtId` | `string` | "jti" (JWT ID) Claim value to set on the JWT Claims Set. | #### Returns @@ -275,7 +275,7 @@ SignJWT.setJti node_modules/jose/dist/types/jwt/produce.d.ts:30 ---- +___ ### setNotBefore @@ -285,8 +285,8 @@ Set "nbf" (Not Before) Claim. #### Parameters -| Name | Type | Description | -| :------ | :------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `input` | `string` \| `number` | "nbf" (Not Before) Claim value to set on the JWT Claims Set. When number is passed that is used as a value, when string is passed it is resolved to a time span and added to the current timestamp. | #### Returns @@ -301,7 +301,7 @@ SignJWT.setNotBefore node_modules/jose/dist/types/jwt/produce.d.ts:38 ---- +___ ### setProtectedHeader @@ -309,8 +309,8 @@ node_modules/jose/dist/types/jwt/produce.d.ts:38 #### Parameters -| Name | Type | -| :---------------- | :-------------------- | +| Name | Type | +| :------ | :------ | | `protectedHeader` | `JWSHeaderParameters` | #### Returns @@ -323,9 +323,9 @@ SignJWT.setProtectedHeader #### Defined in -[src/nevermined/utils/JwtUtils.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L14) +[src/nevermined/utils/JwtUtils.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L14) ---- +___ ### setSubject @@ -335,8 +335,8 @@ Set "sub" (Subject) Claim. #### Parameters -| Name | Type | Description | -| :-------- | :------- | :-------------------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `subject` | `string` | "sub" (Subject) Claim value to set on the JWT Claims Set. | #### Returns @@ -351,7 +351,7 @@ SignJWT.setSubject node_modules/jose/dist/types/jwt/produce.d.ts:18 ---- +___ ### sign @@ -361,10 +361,10 @@ Signs and returns the JWT. #### Parameters -| Name | Type | Description | -| :--------- | :------------------------ | :------------------------------------------------------------------------------------------------------------------------------ | -| `key` | `Uint8Array` \| `KeyLike` | Private Key or Secret to sign the JWT with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). | -| `options?` | `SignOptions` | JWT Sign options. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `key` | `Uint8Array` \| `KeyLike` | Private Key or Secret to sign the JWT with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jws-alg). | +| `options?` | `SignOptions` | JWT Sign options. | #### Returns @@ -378,7 +378,7 @@ SignJWT.sign node_modules/jose/dist/types/jwt/sign.d.ts:22 ---- +___ ### signText @@ -386,10 +386,10 @@ node_modules/jose/dist/types/jwt/sign.d.ts:22 #### Parameters -| Name | Type | -| :-------- | :----------------------- | -| `text` | `string` \| `Uint8Array` | -| `account` | `Account` | +| Name | Type | +| :------ | :------ | +| `text` | `string` \| `Uint8Array` | +| `account` | `Account` | #### Returns @@ -397,4 +397,4 @@ node_modules/jose/dist/types/jwt/sign.d.ts:22 #### Defined in -[src/nevermined/utils/JwtUtils.ts:77](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L77) +[src/nevermined/utils/JwtUtils.ts:77](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L77) diff --git a/docs/nevermined-sdk/api-reference/classes/EventHandler.md b/docs/nevermined-sdk/api-reference/classes/EventHandler.md index a074a11ce0..8c7be3b351 100644 --- a/docs/nevermined-sdk/api-reference/classes/EventHandler.md +++ b/docs/nevermined-sdk/api-reference/classes/EventHandler.md @@ -45,9 +45,9 @@ #### Defined in -[src/events/EventHandler.ts:6](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/EventHandler.ts#L6) +[src/events/EventHandler.ts:6](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/EventHandler.ts#L6) ---- +___ ### getBlockNumber @@ -63,9 +63,9 @@ #### Defined in -[src/events/EventHandler.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/EventHandler.ts#L16) +[src/events/EventHandler.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/EventHandler.ts#L16) ---- +___ ### interval @@ -73,9 +73,9 @@ #### Defined in -[src/events/EventHandler.ts:10](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/EventHandler.ts#L10) +[src/events/EventHandler.ts:10](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/EventHandler.ts#L10) ---- +___ ### lastBlock @@ -83,9 +83,9 @@ #### Defined in -[src/events/EventHandler.ts:8](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/EventHandler.ts#L8) +[src/events/EventHandler.ts:8](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/EventHandler.ts#L8) ---- +___ ### lastTimeout @@ -93,9 +93,9 @@ #### Defined in -[src/events/EventHandler.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/EventHandler.ts#L14) +[src/events/EventHandler.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/EventHandler.ts#L14) ---- +___ ### polling @@ -103,7 +103,7 @@ #### Defined in -[src/events/EventHandler.ts:12](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/EventHandler.ts#L12) +[src/events/EventHandler.ts:12](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/EventHandler.ts#L12) ## Accessors @@ -117,7 +117,7 @@ #### Defined in -[src/events/EventHandler.ts:2](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/EventHandler.ts#L2) +[src/events/EventHandler.ts:2](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/EventHandler.ts#L2) ## Methods @@ -127,8 +127,8 @@ #### Parameters -| Name | Type | -| :------------ | :-------- | +| Name | Type | +| :------ | :------ | | `isInterval?` | `boolean` | #### Returns @@ -137,9 +137,9 @@ #### Defined in -[src/events/EventHandler.ts:38](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/EventHandler.ts#L38) +[src/events/EventHandler.ts:38](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/EventHandler.ts#L38) ---- +___ ### subscribe @@ -147,24 +147,24 @@ #### Parameters -| Name | Type | -| :--------------- | :---------------------------------- | -| `callback` | (`blockNumber`: `bigint`) => `void` | -| `getBlockNumber` | () => `Promise`\<`bigint`\> | +| Name | Type | +| :------ | :------ | +| `callback` | (`blockNumber`: `bigint`) => `void` | +| `getBlockNumber` | () => `Promise`\<`bigint`\> | #### Returns `Object` -| Name | Type | -| :------------ | :----------- | +| Name | Type | +| :------ | :------ | | `unsubscribe` | () => `void` | #### Defined in -[src/events/EventHandler.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/EventHandler.ts#L18) +[src/events/EventHandler.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/EventHandler.ts#L18) ---- +___ ### unsubscribe @@ -172,8 +172,8 @@ #### Parameters -| Name | Type | -| :--------- | :---------------------------------- | +| Name | Type | +| :------ | :------ | | `callback` | (`blockNumber`: `bigint`) => `void` | #### Returns @@ -182,4 +182,4 @@ #### Defined in -[src/events/EventHandler.ts:28](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/EventHandler.ts#L28) +[src/events/EventHandler.ts:28](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/EventHandler.ts#L28) diff --git a/docs/nevermined-sdk/api-reference/classes/GenericContract.md b/docs/nevermined-sdk/api-reference/classes/GenericContract.md index 617032e9a4..bc65d2b2f2 100644 --- a/docs/nevermined-sdk/api-reference/classes/GenericContract.md +++ b/docs/nevermined-sdk/api-reference/classes/GenericContract.md @@ -58,10 +58,10 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | -| `address` | `string` | +| `address` | `string` | #### Returns @@ -73,7 +73,7 @@ #### Defined in -[src/keeper/contracts/GenericContract.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/GenericContract.ts#L19) +[src/keeper/contracts/GenericContract.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/GenericContract.ts#L19) ## Properties @@ -87,9 +87,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -101,9 +101,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -115,9 +115,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -129,9 +129,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### fixedAddress @@ -139,9 +139,9 @@ #### Defined in -[src/keeper/contracts/GenericContract.ts:7](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/GenericContract.ts#L7) +[src/keeper/contracts/GenericContract.ts:7](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/GenericContract.ts#L7) ---- +___ ### version @@ -153,7 +153,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -171,9 +171,9 @@ ContractBase.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -189,9 +189,9 @@ ContractBase.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -207,9 +207,9 @@ ContractBase.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -225,9 +225,9 @@ ContractBase.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -243,9 +243,9 @@ ContractBase.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -261,9 +261,9 @@ ContractBase.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -279,9 +279,9 @@ ContractBase.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -297,9 +297,9 @@ ContractBase.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -309,69 +309,69 @@ ContractBase.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -379,9 +379,9 @@ ContractBase.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -391,38 +391,38 @@ ContractBase.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -430,7 +430,7 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -441,15 +441,15 @@ ContractBase.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :----- | :------- | +| Name | Type | +| :------ | :------ | | `name` | `string` | -| `args` | `any`[] | +| `args` | `any`[] | | `from` | `string` | #### Returns @@ -462,9 +462,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/GenericContract.ts:35](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/GenericContract.ts#L35) +[src/keeper/contracts/GenericContract.ts:35](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/GenericContract.ts#L35) ---- +___ ### getContract @@ -476,9 +476,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/GenericContract.ts:43](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/GenericContract.ts#L43) +[src/keeper/contracts/GenericContract.ts:43](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/GenericContract.ts#L43) ---- +___ ### getFromAddress @@ -486,8 +486,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -500,24 +500,24 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -525,9 +525,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -535,10 +535,10 @@ ContractBase.walletClient #### Parameters -| Name | Type | Default value | -| :--------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | #### Returns @@ -550,9 +550,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/GenericContract.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/GenericContract.ts#L24) +[src/keeper/contracts/GenericContract.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/GenericContract.ts#L24) ---- +___ ### send @@ -560,11 +560,11 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------- | -| `name` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | | `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -577,9 +577,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/GenericContract.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/GenericContract.ts#L39) +[src/keeper/contracts/GenericContract.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/GenericContract.ts#L39) ---- +___ ### sendFrom @@ -587,12 +587,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -604,9 +604,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -614,8 +614,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -628,9 +628,9 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -638,8 +638,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -652,9 +652,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -662,11 +662,11 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------------------- | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | -| `contractName` | `string` | -| `address` | `string` | +| Name | Type | +| :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | +| `contractName` | `string` | +| `address` | `string` | #### Returns @@ -678,9 +678,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/GenericContract.ts:9](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/GenericContract.ts#L9) +[src/keeper/contracts/GenericContract.ts:9](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/GenericContract.ts#L9) ---- +___ ### setInstanceConfig @@ -688,15 +688,15 @@ ContractBase.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -709,4 +709,4 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/GraphError.md b/docs/nevermined-sdk/api-reference/classes/GraphError.md index 0390195d64..67bb749e2e 100644 --- a/docs/nevermined-sdk/api-reference/classes/GraphError.md +++ b/docs/nevermined-sdk/api-reference/classes/GraphError.md @@ -35,8 +35,8 @@ #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `message` | `string` | #### Returns @@ -49,7 +49,7 @@ Error.constructor #### Defined in -[src/errors/NeverminedErrors.ts:8](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/errors/NeverminedErrors.ts#L8) +[src/errors/NeverminedErrors.ts:8](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/errors/NeverminedErrors.ts#L8) ## Properties @@ -65,7 +65,7 @@ Error.cause node_modules/typescript/lib/lib.es2022.error.d.ts:24 ---- +___ ### message @@ -79,7 +79,7 @@ Error.message node_modules/typescript/lib/lib.es5.d.ts:1077 ---- +___ ### name @@ -93,7 +93,7 @@ Error.name node_modules/typescript/lib/lib.es5.d.ts:1076 ---- +___ ### stack @@ -107,7 +107,7 @@ Error.stack node_modules/typescript/lib/lib.es5.d.ts:1078 ---- +___ ### prepareStackTrace @@ -125,9 +125,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ##### Parameters -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | +| Name | Type | +| :------ | :------ | +| `err` | `Error` | | `stackTraces` | `CallSite`[] | ##### Returns @@ -142,7 +142,7 @@ Error.prepareStackTrace node_modules/@types/node/globals.d.ts:28 ---- +___ ### stackTraceLimit @@ -166,9 +166,9 @@ Create .stack property on a target object #### Parameters -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | | `constructorOpt?` | `Function` | #### Returns diff --git a/docs/nevermined-sdk/api-reference/classes/HttpError.md b/docs/nevermined-sdk/api-reference/classes/HttpError.md index ce087bf894..9e5293570c 100644 --- a/docs/nevermined-sdk/api-reference/classes/HttpError.md +++ b/docs/nevermined-sdk/api-reference/classes/HttpError.md @@ -35,10 +35,10 @@ #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `message` | `string` | -| `code` | `number` | +| `code` | `number` | #### Returns @@ -50,7 +50,7 @@ Error.constructor #### Defined in -[src/errors/NeverminedErrors.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/errors/NeverminedErrors.ts#L14) +[src/errors/NeverminedErrors.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/errors/NeverminedErrors.ts#L14) ## Properties @@ -66,7 +66,7 @@ Error.cause node_modules/typescript/lib/lib.es2022.error.d.ts:24 ---- +___ ### message @@ -80,7 +80,7 @@ Error.message node_modules/typescript/lib/lib.es5.d.ts:1077 ---- +___ ### name @@ -94,7 +94,7 @@ Error.name node_modules/typescript/lib/lib.es5.d.ts:1076 ---- +___ ### stack @@ -108,7 +108,7 @@ Error.stack node_modules/typescript/lib/lib.es5.d.ts:1078 ---- +___ ### prepareStackTrace @@ -126,9 +126,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ##### Parameters -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | +| Name | Type | +| :------ | :------ | +| `err` | `Error` | | `stackTraces` | `CallSite`[] | ##### Returns @@ -143,7 +143,7 @@ Error.prepareStackTrace node_modules/@types/node/globals.d.ts:28 ---- +___ ### stackTraceLimit @@ -167,9 +167,9 @@ Create .stack property on a target object #### Parameters -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | | `constructorOpt?` | `Function` | #### Returns diff --git a/docs/nevermined-sdk/api-reference/classes/Instantiable.md b/docs/nevermined-sdk/api-reference/classes/Instantiable.md index 22abafd512..c8a4b4a1e8 100644 --- a/docs/nevermined-sdk/api-reference/classes/Instantiable.md +++ b/docs/nevermined-sdk/api-reference/classes/Instantiable.md @@ -101,7 +101,7 @@ #### Defined in -[src/Instantiable.abstract.ts:156](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L156) +[src/Instantiable.abstract.ts:156](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L156) ## Accessors @@ -115,9 +115,9 @@ #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -129,9 +129,9 @@ #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -143,9 +143,9 @@ #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -157,9 +157,9 @@ #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -171,9 +171,9 @@ #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -185,9 +185,9 @@ #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -199,9 +199,9 @@ #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -213,9 +213,9 @@ #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -225,75 +225,75 @@ `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -303,42 +303,42 @@ `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -348,8 +348,8 @@ #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -358,9 +358,9 @@ #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### getInstance @@ -368,8 +368,8 @@ #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -378,9 +378,9 @@ #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -388,15 +388,15 @@ #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -405,4 +405,4 @@ #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/JwtUtils.md b/docs/nevermined-sdk/api-reference/classes/JwtUtils.md index c990a7ee51..7b57a852e4 100644 --- a/docs/nevermined-sdk/api-reference/classes/JwtUtils.md +++ b/docs/nevermined-sdk/api-reference/classes/JwtUtils.md @@ -16,9 +16,9 @@ ### Properties -- [BASE_AUD](JwtUtils.md#base_aud) +- [BASE\_AUD](JwtUtils.md#base_aud) - [tokenCache](JwtUtils.md#tokencache) -- [CLIENT_ASSERTION_TYPE](JwtUtils.md#client_assertion_type) +- [CLIENT\_ASSERTION\_TYPE](JwtUtils.md#client_assertion_type) ### Accessors @@ -61,8 +61,8 @@ #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -75,19 +75,19 @@ #### Defined in -[src/nevermined/utils/JwtUtils.ts:117](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L117) +[src/nevermined/utils/JwtUtils.ts:117](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L117) ## Properties -### BASE_AUD +### BASE\_AUD -• **BASE_AUD**: `string` = `'/api/v1/node/services'` +• **BASE\_AUD**: `string` = `'/api/v1/node/services'` #### Defined in -[src/nevermined/utils/JwtUtils.ts:113](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L113) +[src/nevermined/utils/JwtUtils.ts:113](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L113) ---- +___ ### tokenCache @@ -95,17 +95,17 @@ #### Defined in -[src/nevermined/utils/JwtUtils.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L115) +[src/nevermined/utils/JwtUtils.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L115) ---- +___ -### CLIENT_ASSERTION_TYPE +### CLIENT\_ASSERTION\_TYPE -▪ `Static` **CLIENT_ASSERTION_TYPE**: `string` = `'urn:ietf:params:oauth:client-assertion-type:jwt-bearer'` +▪ `Static` **CLIENT\_ASSERTION\_TYPE**: `string` = `'urn:ietf:params:oauth:client-assertion-type:jwt-bearer'` #### Defined in -[src/nevermined/utils/JwtUtils.ts:112](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L112) +[src/nevermined/utils/JwtUtils.ts:112](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L112) ## Accessors @@ -123,9 +123,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -141,9 +141,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -159,9 +159,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -177,9 +177,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -195,9 +195,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -213,9 +213,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -231,9 +231,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -249,9 +249,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -261,69 +261,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -331,9 +331,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -343,38 +343,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -382,7 +382,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -392,8 +392,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :-------- | :---------------------------- | +| Name | Type | +| :------ | :------ | | `account` | [`NvmAccount`](NvmAccount.md) | #### Returns @@ -402,9 +402,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/JwtUtils.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L127) +[src/nevermined/utils/JwtUtils.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L127) ---- +___ ### generateAccessGrantToken @@ -412,13 +412,13 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------------------- | :------------------------------------ | -| `account` | [`NvmAccount`](NvmAccount.md) | -| `serviceAgreementId` | `string` | -| `did` | `string` | -| `buyer?` | `string` | -| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | +| Name | Type | +| :------ | :------ | +| `account` | [`NvmAccount`](NvmAccount.md) | +| `serviceAgreementId` | `string` | +| `did` | `string` | +| `buyer?` | `string` | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | #### Returns @@ -426,9 +426,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/JwtUtils.ts:169](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L169) +[src/nevermined/utils/JwtUtils.ts:169](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L169) ---- +___ ### generateCacheKey @@ -436,8 +436,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :-------- | :--------- | +| Name | Type | +| :------ | :------ | | `...args` | `string`[] | #### Returns @@ -446,9 +446,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/JwtUtils.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L123) +[src/nevermined/utils/JwtUtils.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L123) ---- +___ ### generateClientAssertion @@ -456,10 +456,10 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------- | :---------------------------- | -| `account` | [`NvmAccount`](NvmAccount.md) | -| `message?` | `string` | +| Name | Type | +| :------ | :------ | +| `account` | [`NvmAccount`](NvmAccount.md) | +| `message?` | `string` | #### Returns @@ -467,9 +467,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/JwtUtils.ts:148](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L148) +[src/nevermined/utils/JwtUtils.ts:148](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L148) ---- +___ ### generateComputeGrantToken @@ -477,11 +477,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------------------- | :---------------------------- | -| `account` | [`NvmAccount`](NvmAccount.md) | -| `serviceAgreementId` | `string` | -| `executionId` | `string` | +| Name | Type | +| :------ | :------ | +| `account` | [`NvmAccount`](NvmAccount.md) | +| `serviceAgreementId` | `string` | +| `executionId` | `string` | #### Returns @@ -489,9 +489,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/JwtUtils.ts:277](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L277) +[src/nevermined/utils/JwtUtils.ts:277](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L277) ---- +___ ### generateDownloadGrantToken @@ -499,11 +499,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------- | :------------------------------------ | -| `account` | [`NvmAccount`](NvmAccount.md) | -| `did` | `string` | -| `buyer?` | `string` | +| Name | Type | +| :------ | :------ | +| `account` | [`NvmAccount`](NvmAccount.md) | +| `did` | `string` | +| `buyer?` | `string` | | `babysig?` | [`Babysig`](../interfaces/Babysig.md) | #### Returns @@ -512,9 +512,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/JwtUtils.ts:216](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L216) +[src/nevermined/utils/JwtUtils.ts:216](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L216) ---- +___ ### generateExecuteGrantToken @@ -522,11 +522,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------------------- | :---------------------------- | -| `account` | [`NvmAccount`](NvmAccount.md) | -| `serviceAgreementId` | `string` | -| `workflowId` | `string` | +| Name | Type | +| :------ | :------ | +| `account` | [`NvmAccount`](NvmAccount.md) | +| `serviceAgreementId` | `string` | +| `workflowId` | `string` | #### Returns @@ -534,9 +534,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/JwtUtils.ts:257](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L257) +[src/nevermined/utils/JwtUtils.ts:257](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L257) ---- +___ ### generateNftAccessGrantToken @@ -544,14 +544,14 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------------- | :------------------------------------ | -| `agreementId` | `string` | -| `did` | `string` | -| `serviceIndex` | `number` | -| `account` | [`NvmAccount`](NvmAccount.md) | -| `buyer?` | `string` | -| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `serviceIndex` | `number` | +| `account` | [`NvmAccount`](NvmAccount.md) | +| `buyer?` | `string` | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | #### Returns @@ -559,9 +559,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/JwtUtils.ts:297](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L297) +[src/nevermined/utils/JwtUtils.ts:297](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L297) ---- +___ ### generateToken @@ -569,13 +569,13 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------------------- | :---------------------------- | -| `account` | [`NvmAccount`](NvmAccount.md) | -| `serviceAgreementId` | `string` | -| `did` | `string` | -| `aud` | `string` | -| `obj` | `any` | +| Name | Type | +| :------ | :------ | +| `account` | [`NvmAccount`](NvmAccount.md) | +| `serviceAgreementId` | `string` | +| `did` | `string` | +| `aud` | `string` | +| `obj` | `any` | #### Returns @@ -583,9 +583,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/JwtUtils.ts:193](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L193) +[src/nevermined/utils/JwtUtils.ts:193](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L193) ---- +___ ### getDownloadGrantToken @@ -593,11 +593,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------- | :------------------------------------ | -| `did` | `string` | -| `account` | [`NvmAccount`](NvmAccount.md) | -| `buyer?` | `string` | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `account` | [`NvmAccount`](NvmAccount.md) | +| `buyer?` | `string` | | `babysig?` | [`Babysig`](../interfaces/Babysig.md) | #### Returns @@ -606,9 +606,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/JwtUtils.ts:238](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L238) +[src/nevermined/utils/JwtUtils.ts:238](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L238) ---- +___ ### getNftAccessGrantToken @@ -616,14 +616,14 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------------- | :------------------------------------ | -| `agreementId` | `string` | -| `did` | `string` | -| `serviceIndex` | `number` | -| `account` | [`NvmAccount`](NvmAccount.md) | -| `buyer?` | `string` | -| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `serviceIndex` | `number` | +| `account` | [`NvmAccount`](NvmAccount.md) | +| `buyer?` | `string` | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | #### Returns @@ -631,9 +631,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/JwtUtils.ts:325](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L325) +[src/nevermined/utils/JwtUtils.ts:325](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L325) ---- +___ ### isTokenValid @@ -641,8 +641,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `token` | `string` | #### Returns @@ -651,9 +651,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/JwtUtils.ts:354](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L354) +[src/nevermined/utils/JwtUtils.ts:354](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L354) ---- +___ ### setInstanceConfig @@ -661,8 +661,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -675,9 +675,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### createCompressedJwt @@ -685,8 +685,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `token` | `string` | #### Returns @@ -695,9 +695,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/JwtUtils.ts:368](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L368) +[src/nevermined/utils/JwtUtils.ts:368](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L368) ---- +___ ### decompressJwt @@ -705,8 +705,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :-------------- | :------- | +| Name | Type | +| :------ | :------ | | `compressedJwt` | `string` | #### Returns @@ -715,9 +715,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/JwtUtils.ts:373](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/JwtUtils.ts#L373) +[src/nevermined/utils/JwtUtils.ts:373](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/JwtUtils.ts#L373) ---- +___ ### getInstance @@ -725,8 +725,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -739,9 +739,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -749,15 +749,15 @@ Instantiable.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -770,4 +770,4 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/Keeper.md b/docs/nevermined-sdk/api-reference/classes/Keeper.md index 68493becf6..e70d7ebafe 100644 --- a/docs/nevermined-sdk/api-reference/classes/Keeper.md +++ b/docs/nevermined-sdk/api-reference/classes/Keeper.md @@ -4,7 +4,6 @@ Interface with Nevermined contracts. Nevermined Keeper implementation where we put the following modules together: - - TCRs: users create challenges and resolve them through voting to maintain registries. - Nevermined Tokens: the intrinsic tokens circulated inside Nevermined network, which is used in the voting of TCRs. - Marketplace: the core marketplace where people can transact with each other with Nevermined tokens. @@ -95,9 +94,9 @@ Template store manager smart contract instance. #### Defined in -[src/keeper/Keeper.ts:303](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L303) +[src/keeper/Keeper.ts:303](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L303) ---- +___ ### conditionStoreManager @@ -107,9 +106,9 @@ Template store manager smart contract instance. #### Defined in -[src/keeper/Keeper.ts:308](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L308) +[src/keeper/Keeper.ts:308](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L308) ---- +___ ### conditions @@ -119,26 +118,26 @@ Conditions instances. #### Type declaration -| Name | Type | -| :------------------------------ | :------------------------------------------------------------------ | -| `accessCondition` | [`AccessCondition`](AccessCondition.md) | -| `computeExecutionCondition` | [`ComputeExecutionCondition`](ComputeExecutionCondition.md) | -| `escrowPaymentCondition` | [`EscrowPaymentCondition`](EscrowPaymentCondition.md) | -| `lockPaymentCondition` | [`LockPaymentCondition`](LockPaymentCondition.md) | -| `nft721HolderCondition` | [`NFT721HolderCondition`](NFT721HolderCondition.md) | -| `nft721LockCondition` | `NFT721LockCondition` | -| `nftAccessCondition` | [`NFTAccessCondition`](NFTAccessCondition.md) | -| `nftHolderCondition` | [`NFTHolderCondition`](NFTHolderCondition.md) | -| `nftLockCondition` | [`NFTLockCondition`](NFTLockCondition.md) | +| Name | Type | +| :------ | :------ | +| `accessCondition` | [`AccessCondition`](AccessCondition.md) | +| `computeExecutionCondition` | [`ComputeExecutionCondition`](ComputeExecutionCondition.md) | +| `escrowPaymentCondition` | [`EscrowPaymentCondition`](EscrowPaymentCondition.md) | +| `lockPaymentCondition` | [`LockPaymentCondition`](LockPaymentCondition.md) | +| `nft721HolderCondition` | [`NFT721HolderCondition`](NFT721HolderCondition.md) | +| `nft721LockCondition` | `NFT721LockCondition` | +| `nftAccessCondition` | [`NFTAccessCondition`](NFTAccessCondition.md) | +| `nftHolderCondition` | [`NFTHolderCondition`](NFTHolderCondition.md) | +| `nftLockCondition` | [`NFTLockCondition`](NFTLockCondition.md) | | `transferDidOwnershipCondition` | [`TransferDIDOwnershipCondition`](TransferDIDOwnershipCondition.md) | -| `transferNft721Condition` | [`TransferNFT721Condition`](TransferNFT721Condition.md) | -| `transferNftCondition` | [`TransferNFTCondition`](TransferNFTCondition.md) | +| `transferNft721Condition` | [`TransferNFT721Condition`](TransferNFT721Condition.md) | +| `transferNftCondition` | [`TransferNFTCondition`](TransferNFTCondition.md) | #### Defined in -[src/keeper/Keeper.ts:313](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L313) +[src/keeper/Keeper.ts:313](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L313) ---- +___ ### conditionsList @@ -146,9 +145,9 @@ Conditions instances. #### Defined in -[src/keeper/Keeper.ts:328](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L328) +[src/keeper/Keeper.ts:328](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L328) ---- +___ ### connected @@ -158,9 +157,9 @@ Is connected to the correct network or not. #### Defined in -[src/keeper/Keeper.ts:268](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L268) +[src/keeper/Keeper.ts:268](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L268) ---- +___ ### didRegistry @@ -170,9 +169,9 @@ DID registry smart contract instance. #### Defined in -[src/keeper/Keeper.ts:288](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L288) +[src/keeper/Keeper.ts:288](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L288) ---- +___ ### dispenser @@ -182,9 +181,9 @@ Market smart contract instance. #### Defined in -[src/keeper/Keeper.ts:278](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L278) +[src/keeper/Keeper.ts:278](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L278) ---- +___ ### instances @@ -196,9 +195,9 @@ Market smart contract instance. #### Defined in -[src/keeper/Keeper.ts:382](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L382) +[src/keeper/Keeper.ts:382](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L382) ---- +___ ### network @@ -208,18 +207,18 @@ Network id loaded from web3 #### Type declaration -| Name | Type | Description | -| :--------- | :-------- | :--------------------------------- | -| `chainId?` | `number` | chainId of the network | -| `loading` | `boolean` | True if keeper is still connecting | -| `name?` | `string` | Name of the network | -| `version?` | `string` | Version of the artifacts in use | +| Name | Type | Description | +| :------ | :------ | :------ | +| `chainId?` | `number` | chainId of the network | +| `loading` | `boolean` | True if keeper is still connecting | +| `name?` | `string` | Name of the network | +| `version?` | `string` | Version of the artifacts in use | #### Defined in -[src/keeper/Keeper.ts:361](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L361) +[src/keeper/Keeper.ts:361](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L361) ---- +___ ### nftUpgradeable @@ -229,9 +228,9 @@ NFT upgradeable smart contract instance. #### Defined in -[src/keeper/Keeper.ts:293](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L293) +[src/keeper/Keeper.ts:293](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L293) ---- +___ ### nvmConfig @@ -241,9 +240,9 @@ Nevermined Config smart contract instance. #### Defined in -[src/keeper/Keeper.ts:283](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L283) +[src/keeper/Keeper.ts:283](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L283) ---- +___ ### rewardsDistributor @@ -251,9 +250,9 @@ Nevermined Config smart contract instance. #### Defined in -[src/keeper/Keeper.ts:349](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L349) +[src/keeper/Keeper.ts:349](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L349) ---- +___ ### royalties @@ -261,16 +260,16 @@ Nevermined Config smart contract instance. #### Type declaration -| Name | Type | -| :--------- | :------------------------------------------ | -| `curve` | [`CurveRoyalties`](CurveRoyalties.md) | +| Name | Type | +| :------ | :------ | +| `curve` | [`CurveRoyalties`](CurveRoyalties.md) | | `standard` | [`StandardRoyalties`](StandardRoyalties.md) | #### Defined in -[src/keeper/Keeper.ts:344](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L344) +[src/keeper/Keeper.ts:344](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L344) ---- +___ ### templateList @@ -278,9 +277,9 @@ Nevermined Config smart contract instance. #### Defined in -[src/keeper/Keeper.ts:329](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L329) +[src/keeper/Keeper.ts:329](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L329) ---- +___ ### templateStoreManager @@ -290,9 +289,9 @@ Template store manager smart contract instance. #### Defined in -[src/keeper/Keeper.ts:298](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L298) +[src/keeper/Keeper.ts:298](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L298) ---- +___ ### templates @@ -302,21 +301,21 @@ Templates instances. #### Type declaration -| Name | Type | -| :------------------------------- | :-------------------------------------------------------------------- | -| `accessTemplate` | [`AccessTemplate`](AccessTemplate.md) | -| `didSalesTemplate` | [`DIDSalesTemplate`](DIDSalesTemplate.md) | +| Name | Type | +| :------ | :------ | +| `accessTemplate` | [`AccessTemplate`](AccessTemplate.md) | +| `didSalesTemplate` | [`DIDSalesTemplate`](DIDSalesTemplate.md) | | `escrowComputeExecutionTemplate` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | -| `nft721AccessTemplate` | [`NFT721AccessTemplate`](NFT721AccessTemplate.md) | -| `nft721SalesTemplate` | [`NFT721SalesTemplate`](NFT721SalesTemplate.md) | -| `nftAccessTemplate` | [`NFTAccessTemplate`](NFTAccessTemplate.md) | -| `nftSalesTemplate` | [`NFTSalesTemplate`](NFTSalesTemplate.md) | +| `nft721AccessTemplate` | [`NFT721AccessTemplate`](NFT721AccessTemplate.md) | +| `nft721SalesTemplate` | [`NFT721SalesTemplate`](NFT721SalesTemplate.md) | +| `nftAccessTemplate` | [`NFTAccessTemplate`](NFTAccessTemplate.md) | +| `nftSalesTemplate` | [`NFTSalesTemplate`](NFTSalesTemplate.md) | #### Defined in -[src/keeper/Keeper.ts:334](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L334) +[src/keeper/Keeper.ts:334](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L334) ---- +___ ### token @@ -326,9 +325,9 @@ Nevermined Token smart contract instance. #### Defined in -[src/keeper/Keeper.ts:273](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L273) +[src/keeper/Keeper.ts:273](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L273) ---- +___ ### utils @@ -338,13 +337,13 @@ Helpers for contracts. #### Type declaration -| Name | Type | -| :------------- | :-------------------------------- | +| Name | Type | +| :------ | :------ | | `eventHandler` | [`EventHandler`](EventHandler.md) | #### Defined in -[src/keeper/Keeper.ts:354](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L354) +[src/keeper/Keeper.ts:354](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L354) ## Accessors @@ -362,9 +361,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -380,9 +379,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -398,9 +397,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -416,9 +415,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -434,9 +433,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -452,9 +451,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -470,9 +469,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -488,9 +487,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -500,69 +499,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -570,9 +569,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -582,38 +581,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -621,7 +620,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -633,8 +632,8 @@ Returns a Access template by name. #### Parameters -| Name | Type | Description | -| :----- | :------- | :------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `name` | `string` | Template name. | #### Returns @@ -645,9 +644,9 @@ Agreement template instance. #### Defined in -[src/keeper/Keeper.ts:448](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L448) +[src/keeper/Keeper.ts:448](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L448) ---- +___ ### getAllInstances @@ -659,9 +658,9 @@ Agreement template instance. #### Defined in -[src/keeper/Keeper.ts:461](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L461) +[src/keeper/Keeper.ts:461](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L461) ---- +___ ### getConditionByAddress @@ -671,8 +670,8 @@ Returns a condition by address. #### Parameters -| Name | Type | Description | -| :-------- | :------- | :----------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `address` | `string` | Address of deployed condition. | #### Returns @@ -683,9 +682,9 @@ Condition instance. #### Defined in -[src/keeper/Keeper.ts:389](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L389) +[src/keeper/Keeper.ts:389](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L389) ---- +___ ### getNetworkId @@ -701,9 +700,9 @@ Network ID. #### Defined in -[src/keeper/Keeper.ts:419](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L419) +[src/keeper/Keeper.ts:419](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L419) ---- +___ ### getNetworkName @@ -719,9 +718,9 @@ Network name. #### Defined in -[src/keeper/Keeper.ts:408](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L408) +[src/keeper/Keeper.ts:408](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L408) ---- +___ ### getNetworkVersion @@ -737,9 +736,9 @@ Network version. #### Defined in -[src/keeper/Keeper.ts:436](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L436) +[src/keeper/Keeper.ts:436](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L436) ---- +___ ### getTemplateByAddress @@ -749,8 +748,8 @@ Returns a template by address. #### Parameters -| Name | Type | Description | -| :-------- | :------- | :---------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `address` | `string` | Template address. | #### Returns @@ -761,9 +760,9 @@ Agreement template instance. #### Defined in -[src/keeper/Keeper.ts:457](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L457) +[src/keeper/Keeper.ts:457](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L457) ---- +___ ### getTemplateByName @@ -773,8 +772,8 @@ Returns a template by name. #### Parameters -| Name | Type | Description | -| :----- | :------- | :------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `name` | `string` | Template name. | #### Returns @@ -785,9 +784,9 @@ Agreement template instance. #### Defined in -[src/keeper/Keeper.ts:400](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L400) +[src/keeper/Keeper.ts:400](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L400) ---- +___ ### init @@ -795,8 +794,8 @@ Agreement template instance. #### Parameters -| Name | Type | -| :------------ | :------------------------------------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `initOptions` | [`NeverminedInitializationOptions`](../interfaces/NeverminedInitializationOptions.md) | #### Returns @@ -805,9 +804,9 @@ Agreement template instance. #### Defined in -[src/keeper/Keeper.ts:63](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L63) +[src/keeper/Keeper.ts:63](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L63) ---- +___ ### loadCurveRoyaltiesInstance @@ -819,9 +818,9 @@ Agreement template instance. #### Defined in -[src/keeper/Keeper.ts:465](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L465) +[src/keeper/Keeper.ts:465](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L465) ---- +___ ### setInstanceConfig @@ -829,8 +828,8 @@ Agreement template instance. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -843,9 +842,9 @@ Agreement template instance. #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### getInstance @@ -855,8 +854,8 @@ Returns Keeper instance. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -871,9 +870,9 @@ Returns Keeper instance. #### Defined in -[src/keeper/Keeper.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/Keeper.ts#L57) +[src/keeper/Keeper.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/Keeper.ts#L57) ---- +___ ### setInstanceConfig @@ -881,15 +880,15 @@ Returns Keeper instance. #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -902,4 +901,4 @@ Returns Keeper instance. #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/KeeperError.md b/docs/nevermined-sdk/api-reference/classes/KeeperError.md index e5e7940bc3..9090ff6b19 100644 --- a/docs/nevermined-sdk/api-reference/classes/KeeperError.md +++ b/docs/nevermined-sdk/api-reference/classes/KeeperError.md @@ -35,8 +35,8 @@ #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `message` | `string` | #### Returns @@ -49,7 +49,7 @@ Error.constructor #### Defined in -[src/errors/NeverminedErrors.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/errors/NeverminedErrors.ts#L20) +[src/errors/NeverminedErrors.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/errors/NeverminedErrors.ts#L20) ## Properties @@ -65,7 +65,7 @@ Error.cause node_modules/typescript/lib/lib.es2022.error.d.ts:24 ---- +___ ### message @@ -79,7 +79,7 @@ Error.message node_modules/typescript/lib/lib.es5.d.ts:1077 ---- +___ ### name @@ -93,7 +93,7 @@ Error.name node_modules/typescript/lib/lib.es5.d.ts:1076 ---- +___ ### stack @@ -107,7 +107,7 @@ Error.stack node_modules/typescript/lib/lib.es5.d.ts:1078 ---- +___ ### prepareStackTrace @@ -125,9 +125,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ##### Parameters -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | +| Name | Type | +| :------ | :------ | +| `err` | `Error` | | `stackTraces` | `CallSite`[] | ##### Returns @@ -142,7 +142,7 @@ Error.prepareStackTrace node_modules/@types/node/globals.d.ts:28 ---- +___ ### stackTraceLimit @@ -166,9 +166,9 @@ Create .stack property on a target object #### Parameters -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | | `constructorOpt?` | `Function` | #### Returns diff --git a/docs/nevermined-sdk/api-reference/classes/KeyTransfer.BabyjubPublicKey.md b/docs/nevermined-sdk/api-reference/classes/KeyTransfer.BabyjubPublicKey.md deleted file mode 100644 index 5c45b1c42a..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/KeyTransfer.BabyjubPublicKey.md +++ /dev/null @@ -1,71 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [KeyTransfer](../modules/KeyTransfer.md) / BabyjubPublicKey - -# Class: BabyjubPublicKey - -[KeyTransfer](../modules/KeyTransfer.md).BabyjubPublicKey - -## Table of contents - -### Constructors - -- [constructor](KeyTransfer.BabyjubPublicKey.md#constructor) - -### Properties - -- [x](KeyTransfer.BabyjubPublicKey.md#x) -- [y](KeyTransfer.BabyjubPublicKey.md#y) - -### Methods - -- [param](KeyTransfer.BabyjubPublicKey.md#param) - -## Constructors - -### constructor - -• **new BabyjubPublicKey**(`x`, `y`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `x` | `string` | -| `y` | `string` | - -#### Defined in - -[src/models/KeyTransfer.ts:8](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L8) - -## Properties - -### x - -• **x**: `string` - -#### Defined in - -[src/models/KeyTransfer.ts:5](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L5) - -___ - -### y - -• **y**: `string` - -#### Defined in - -[src/models/KeyTransfer.ts:6](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L6) - -## Methods - -### param - -▸ **param**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -[src/models/KeyTransfer.ts:13](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L13) diff --git a/docs/nevermined-sdk/api-reference/classes/KeyTransfer.MimcCipher.md b/docs/nevermined-sdk/api-reference/classes/KeyTransfer.MimcCipher.md deleted file mode 100644 index 5f3de51569..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/KeyTransfer.MimcCipher.md +++ /dev/null @@ -1,71 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [KeyTransfer](../modules/KeyTransfer.md) / MimcCipher - -# Class: MimcCipher - -[KeyTransfer](../modules/KeyTransfer.md).MimcCipher - -## Table of contents - -### Constructors - -- [constructor](KeyTransfer.MimcCipher.md#constructor) - -### Properties - -- [x](KeyTransfer.MimcCipher.md#x) -- [y](KeyTransfer.MimcCipher.md#y) - -### Methods - -- [param](KeyTransfer.MimcCipher.md#param) - -## Constructors - -### constructor - -• **new MimcCipher**(`x`, `y`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `x` | `string` | -| `y` | `string` | - -#### Defined in - -[src/models/KeyTransfer.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L23) - -## Properties - -### x - -• **x**: `string` - -#### Defined in - -[src/models/KeyTransfer.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L20) - -___ - -### y - -• **y**: `string` - -#### Defined in - -[src/models/KeyTransfer.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L21) - -## Methods - -### param - -▸ **param**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -[src/models/KeyTransfer.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L28) diff --git a/docs/nevermined-sdk/api-reference/classes/LockPaymentCondition.md b/docs/nevermined-sdk/api-reference/classes/LockPaymentCondition.md index a0404b357a..5b29d94a52 100644 --- a/docs/nevermined-sdk/api-reference/classes/LockPaymentCondition.md +++ b/docs/nevermined-sdk/api-reference/classes/LockPaymentCondition.md @@ -71,8 +71,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -85,7 +85,7 @@ ConsumerCondition\.constructor #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -99,9 +99,9 @@ ConsumerCondition.address #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -113,9 +113,9 @@ ConsumerCondition.contract #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -127,9 +127,9 @@ ConsumerCondition.contractName #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -141,9 +141,9 @@ ConsumerCondition.events #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -155,7 +155,7 @@ ConsumerCondition.version #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -173,9 +173,9 @@ ConsumerCondition.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -191,9 +191,9 @@ ConsumerCondition.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -209,9 +209,9 @@ ConsumerCondition.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -227,9 +227,9 @@ ConsumerCondition.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -245,9 +245,9 @@ ConsumerCondition.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -263,9 +263,9 @@ ConsumerCondition.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -281,9 +281,9 @@ ConsumerCondition.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -299,9 +299,9 @@ ConsumerCondition.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -311,69 +311,69 @@ ConsumerCondition.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -381,9 +381,9 @@ ConsumerCondition.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -393,38 +393,38 @@ ConsumerCondition.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -432,7 +432,7 @@ ConsumerCondition.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -442,11 +442,11 @@ ConsumerCondition.walletClient #### Parameters -| Name | Type | -| :------------ | :---------------------------------------------- | -| `conditionId` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `conditionId` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -458,9 +458,9 @@ ConsumerCondition.abortByTimeOut #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L75) +[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L75) ---- +___ ### call @@ -469,16 +469,16 @@ ConsumerCondition.abortByTimeOut #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -490,9 +490,9 @@ ConsumerCondition.call #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### fulfill @@ -500,16 +500,16 @@ ConsumerCondition.call #### Parameters -| Name | Type | -| :-------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `bigint`[] | -| `receivers` | `string`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -521,9 +521,9 @@ ConsumerCondition.fulfill #### Defined in -[src/keeper/contracts/conditions/LockPaymentCondition.ts:42](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/LockPaymentCondition.ts#L42) +[src/keeper/contracts/conditions/LockPaymentCondition.ts:42](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/LockPaymentCondition.ts#L42) ---- +___ ### fulfillInstance @@ -531,13 +531,13 @@ ConsumerCondition.fulfill #### Parameters -| Name | Type | Default value | -| :----------------- | :-------------------------------------------------------- | :------------ | -| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -549,9 +549,9 @@ ConsumerCondition.fulfillInstance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L139) +[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L139) ---- +___ ### fulfillPlain @@ -559,13 +559,13 @@ ConsumerCondition.fulfillInstance #### Parameters -| Name | Type | Default value | -| :------------ | :-------------------------------------------------------- | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -577,9 +577,9 @@ ConsumerCondition.fulfillPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L47) +[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L47) ---- +___ ### fulfillWithNode @@ -587,12 +587,12 @@ ConsumerCondition.fulfillPlain #### Parameters -| Name | Type | -| :------------------ | :----------------------------------------------------- | -| `_cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | -| `_additionalParams` | `Record`\<`string`, `unknown`\> | -| `_from` | [`NvmAccount`](NvmAccount.md) | -| `_txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `_cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | +| `_additionalParams` | `Record`\<`string`, `unknown`\> | +| `_from` | [`NvmAccount`](NvmAccount.md) | +| `_txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -604,9 +604,9 @@ ConsumerCondition.fulfillWithNode #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:209](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L209) +[src/keeper/contracts/conditions/Condition.abstract.ts:209](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L209) ---- +___ ### generateId @@ -614,10 +614,10 @@ ConsumerCondition.fulfillWithNode #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -629,9 +629,9 @@ ConsumerCondition.generateId #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L61) +[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L61) ---- +___ ### generateIdHash @@ -639,10 +639,10 @@ ConsumerCondition.generateId #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `...values` | `any`[] | +| `...values` | `any`[] | #### Returns @@ -654,9 +654,9 @@ ConsumerCondition.generateIdHash #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L57) +[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L57) ---- +___ ### generateIdWithSeed @@ -664,10 +664,10 @@ ConsumerCondition.generateIdHash #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -679,9 +679,9 @@ ConsumerCondition.generateIdWithSeed #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L65) +[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L65) ---- +___ ### getConditionFulfilledEvent @@ -689,8 +689,8 @@ ConsumerCondition.generateIdWithSeed #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns @@ -703,9 +703,9 @@ ConsumerCondition.getConditionFulfilledEvent #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L79) +[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L79) ---- +___ ### getFromAddress @@ -713,8 +713,8 @@ ConsumerCondition.getConditionFulfilledEvent #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -727,24 +727,24 @@ ConsumerCondition.getFromAddress #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -752,9 +752,9 @@ ConsumerCondition.getTransactionLogs #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### hashValues @@ -762,8 +762,8 @@ ConsumerCondition.getTransactionLogs #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -776,9 +776,9 @@ ConsumerCondition.hashValues #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L116) +[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L116) ---- +___ ### hashValuesPlain @@ -786,8 +786,8 @@ ConsumerCondition.hashValues #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -800,9 +800,9 @@ ConsumerCondition.hashValuesPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L122) +[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L122) ---- +___ ### init @@ -810,11 +810,11 @@ ConsumerCondition.hashValuesPlain #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -826,9 +826,9 @@ ConsumerCondition.init #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instance @@ -836,10 +836,10 @@ ConsumerCondition.init #### Parameters -| Name | Type | -| :------------ | :------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | #### Returns @@ -851,9 +851,9 @@ ConsumerCondition.instance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L163) +[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L163) ---- +___ ### instanceFromDDO @@ -861,11 +861,11 @@ ConsumerCondition.instance #### Parameters -| Name | Type | -| :------------ | :-------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `ConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `ctx` | `ConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | #### Returns @@ -877,9 +877,9 @@ ConsumerCondition.instanceFromDDO #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L131) +[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L131) ---- +___ ### params @@ -887,13 +887,13 @@ ConsumerCondition.instanceFromDDO #### Parameters -| Name | Type | -| :-------------- | :--------- | -| `did` | `string` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `bigint`[] | -| `receivers` | `string`[] | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | #### Returns @@ -905,9 +905,9 @@ ConsumerCondition.params #### Defined in -[src/keeper/contracts/conditions/LockPaymentCondition.ts:13](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/LockPaymentCondition.ts#L13) +[src/keeper/contracts/conditions/LockPaymentCondition.ts:13](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/LockPaymentCondition.ts#L13) ---- +___ ### paramsFromDDO @@ -915,8 +915,8 @@ ConsumerCondition.params #### Parameters -| Name | Type | -| :--------------- | :----------------- | +| Name | Type | +| :------ | :------ | | `«destructured»` | `ConditionContext` | #### Returns @@ -929,9 +929,9 @@ ConsumerCondition.paramsFromDDO #### Defined in -[src/keeper/contracts/conditions/LockPaymentCondition.ts:31](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/LockPaymentCondition.ts#L31) +[src/keeper/contracts/conditions/LockPaymentCondition.ts:31](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/LockPaymentCondition.ts#L31) ---- +___ ### send @@ -939,12 +939,12 @@ ConsumerCondition.paramsFromDDO #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -956,9 +956,9 @@ ConsumerCondition.send #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -966,12 +966,12 @@ ConsumerCondition.send #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -983,9 +983,9 @@ ConsumerCondition.sendFrom #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -993,8 +993,8 @@ ConsumerCondition.sendFrom #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1007,9 +1007,9 @@ ConsumerCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1017,8 +1017,8 @@ ConsumerCondition.setInstanceConfig #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1031,9 +1031,9 @@ ConsumerCondition.someLog #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -1041,8 +1041,8 @@ ConsumerCondition.someLog #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1055,9 +1055,9 @@ ConsumerCondition.getInstance #### Defined in -[src/keeper/contracts/conditions/LockPaymentCondition.ts:9](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/LockPaymentCondition.ts#L9) +[src/keeper/contracts/conditions/LockPaymentCondition.ts:9](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/LockPaymentCondition.ts#L9) ---- +___ ### setInstanceConfig @@ -1065,15 +1065,15 @@ ConsumerCondition.getInstance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1086,4 +1086,4 @@ ConsumerCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/MarketplaceApi.md b/docs/nevermined-sdk/api-reference/classes/MarketplaceApi.md index ba7b8a285c..218c8848a5 100644 --- a/docs/nevermined-sdk/api-reference/classes/MarketplaceApi.md +++ b/docs/nevermined-sdk/api-reference/classes/MarketplaceApi.md @@ -52,8 +52,8 @@ #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -66,7 +66,7 @@ #### Defined in -[src/services/metadata/MarketplaceAPI.ts:7](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L7) +[src/services/metadata/MarketplaceAPI.ts:7](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L7) ## Accessors @@ -84,9 +84,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -102,9 +102,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -120,9 +120,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -138,9 +138,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -156,9 +156,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -174,9 +174,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -192,9 +192,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -210,9 +210,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -222,69 +222,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -292,9 +292,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### url @@ -306,9 +306,9 @@ Instantiable.publicClient #### Defined in -[src/services/metadata/MarketplaceAPI.ts:12](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L12) +[src/services/metadata/MarketplaceAPI.ts:12](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L12) ---- +___ ### walletClient @@ -318,38 +318,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -357,7 +357,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -367,8 +367,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `clientAssertion` | `string` | #### Returns @@ -377,9 +377,9 @@ Instantiable.walletClient #### Defined in -[src/services/metadata/MarketplaceAPI.ts:36](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L36) +[src/services/metadata/MarketplaceAPI.ts:36](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L36) ---- +___ ### login @@ -387,8 +387,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `clientAssertion` | `string` | #### Returns @@ -397,9 +397,9 @@ Instantiable.walletClient #### Defined in -[src/services/metadata/MarketplaceAPI.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L16) +[src/services/metadata/MarketplaceAPI.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L16) ---- +___ ### setInstanceConfig @@ -407,8 +407,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -421,9 +421,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### getInstance @@ -431,8 +431,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -445,9 +445,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -455,15 +455,15 @@ Instantiable.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -476,4 +476,4 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/MetadataService.md b/docs/nevermined-sdk/api-reference/classes/MetadataService.md index 2afcd13d24..f41ade47a1 100644 --- a/docs/nevermined-sdk/api-reference/classes/MetadataService.md +++ b/docs/nevermined-sdk/api-reference/classes/MetadataService.md @@ -61,8 +61,8 @@ Metadata provides an off-chain database store for metadata about data assets. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -75,7 +75,7 @@ Metadata provides an off-chain database store for metadata about data assets. #### Defined in -[src/services/metadata/MarketplaceAPI.ts:7](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L7) +[src/services/metadata/MarketplaceAPI.ts:7](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L7) ## Accessors @@ -93,9 +93,9 @@ MarketplaceApi.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -111,9 +111,9 @@ MarketplaceApi.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -129,9 +129,9 @@ MarketplaceApi.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -147,9 +147,9 @@ MarketplaceApi.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -165,9 +165,9 @@ MarketplaceApi.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -183,9 +183,9 @@ MarketplaceApi.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -201,9 +201,9 @@ MarketplaceApi.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -219,9 +219,9 @@ MarketplaceApi.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -231,69 +231,69 @@ MarketplaceApi.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -301,9 +301,9 @@ MarketplaceApi.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### url @@ -319,9 +319,9 @@ MarketplaceApi.url #### Defined in -[src/services/metadata/MarketplaceAPI.ts:12](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L12) +[src/services/metadata/MarketplaceAPI.ts:12](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L12) ---- +___ ### walletClient @@ -331,38 +331,38 @@ MarketplaceApi.url `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -370,7 +370,7 @@ MarketplaceApi.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -380,8 +380,8 @@ MarketplaceApi.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `clientAssertion` | `string` | #### Returns @@ -394,9 +394,9 @@ MarketplaceApi.walletClient #### Defined in -[src/services/metadata/MarketplaceAPI.ts:36](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L36) +[src/services/metadata/MarketplaceAPI.ts:36](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L36) ---- +___ ### delete @@ -404,8 +404,8 @@ MarketplaceApi.walletClient #### Parameters -| Name | Type | -| :---- | :-------------------------- | +| Name | Type | +| :------ | :------ | | `did` | `string` \| [`DID`](DID.md) | #### Returns @@ -414,9 +414,9 @@ MarketplaceApi.walletClient #### Defined in -[src/services/metadata/MetadataService.ts:238](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L238) +[src/services/metadata/MetadataService.ts:238](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L238) ---- +___ ### getAccessUrl @@ -424,10 +424,10 @@ MarketplaceApi.walletClient #### Parameters -| Name | Type | -| :------------ | :---- | +| Name | Type | +| :------ | :------ | | `accessToken` | `any` | -| `payload` | `any` | +| `payload` | `any` | #### Returns @@ -435,9 +435,9 @@ MarketplaceApi.walletClient #### Defined in -[src/services/metadata/MetadataService.ts:46](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L46) +[src/services/metadata/MetadataService.ts:46](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L46) ---- +___ ### getServiceEndpoint @@ -445,8 +445,8 @@ MarketplaceApi.walletClient #### Parameters -| Name | Type | -| :---- | :-------------- | +| Name | Type | +| :------ | :------ | | `did` | [`DID`](DID.md) | #### Returns @@ -455,9 +455,9 @@ MarketplaceApi.walletClient #### Defined in -[src/services/metadata/MetadataService.ts:353](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L353) +[src/services/metadata/MetadataService.ts:353](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L353) ---- +___ ### getVersionInfo @@ -469,9 +469,9 @@ MarketplaceApi.walletClient #### Defined in -[src/services/metadata/MetadataService.ts:42](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L42) +[src/services/metadata/MetadataService.ts:42](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L42) ---- +___ ### login @@ -479,8 +479,8 @@ MarketplaceApi.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `clientAssertion` | `string` | #### Returns @@ -493,9 +493,9 @@ MarketplaceApi.walletClient #### Defined in -[src/services/metadata/MarketplaceAPI.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L16) +[src/services/metadata/MarketplaceAPI.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L16) ---- +___ ### queryMetadata @@ -505,8 +505,8 @@ Search over the DDOs using a query. #### Parameters -| Name | Type | Description | -| :------ | :-------------------------------------------- | :------------------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `query` | [`SearchQuery`](../interfaces/SearchQuery.md) | Query to filter the DDOs. | #### Returns @@ -517,9 +517,9 @@ A list of [QueryResult](../interfaces/QueryResult.md)s. #### Defined in -[src/services/metadata/MetadataService.ts:74](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L74) +[src/services/metadata/MetadataService.ts:74](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L74) ---- +___ ### queryServiceMetadata @@ -529,8 +529,8 @@ Search over the Services using a query. #### Parameters -| Name | Type | Description | -| :------ | :------- | :---------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `query` | `Object` | Query to filter the Services. | #### Returns @@ -541,9 +541,9 @@ A list of [ServiceSecondary](../interfaces/ServiceSecondary.md). #### Defined in -[src/services/metadata/MetadataService.ts:106](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L106) +[src/services/metadata/MetadataService.ts:106](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L106) ---- +___ ### retrieveDDO @@ -553,10 +553,10 @@ Retrieves a DDO by DID. #### Parameters -| Name | Type | Description | -| :------------------------- | :-------------------------- | :------------------------- | -| `did?` | `string` \| [`DID`](DID.md) | DID of the asset. | -| `metadataServiceEndpoint?` | `string` | Metadata service endpoint. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did?` | `string` \| [`DID`](DID.md) | DID of the asset. | +| `metadataServiceEndpoint?` | `string` | Metadata service endpoint. | #### Returns @@ -566,9 +566,9 @@ DDO of the asset. #### Defined in -[src/services/metadata/MetadataService.ts:195](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L195) +[src/services/metadata/MetadataService.ts:195](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L195) ---- +___ ### retrieveDDOByUrl @@ -576,8 +576,8 @@ DDO of the asset. #### Parameters -| Name | Type | -| :------------------------- | :------- | +| Name | Type | +| :------ | :------ | | `metadataServiceEndpoint?` | `string` | #### Returns @@ -586,9 +586,9 @@ DDO of the asset. #### Defined in -[src/services/metadata/MetadataService.ts:249](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L249) +[src/services/metadata/MetadataService.ts:249](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L249) ---- +___ ### retrieveDDOFromImmutableBackend @@ -596,8 +596,8 @@ DDO of the asset. #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `immutableUrl` | `string` | #### Returns @@ -606,9 +606,9 @@ DDO of the asset. #### Defined in -[src/services/metadata/MetadataService.ts:227](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L227) +[src/services/metadata/MetadataService.ts:227](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L227) ---- +___ ### retrieveService @@ -618,10 +618,10 @@ Retrieves a service by its agreementId. #### Parameters -| Name | Type | Description | -| :------------------------- | :------- | :-------------------------- | -| `agreementId` | `string` | agreementId of the service. | -| `metadataServiceEndpoint?` | `string` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | agreementId of the service. | +| `metadataServiceEndpoint?` | `string` | - | #### Returns @@ -631,9 +631,9 @@ Service object. #### Defined in -[src/services/metadata/MetadataService.ts:288](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L288) +[src/services/metadata/MetadataService.ts:288](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L288) ---- +___ ### setInstanceConfig @@ -641,8 +641,8 @@ Service object. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -655,9 +655,9 @@ Service object. #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### status @@ -667,10 +667,10 @@ Retrieves a DDO by DID. #### Parameters -| Name | Type | Description | -| :------------------------- | :-------------------------- | :---------------- | -| `did` | `string` \| [`DID`](DID.md) | DID of the asset. | -| `metadataServiceEndpoint?` | `string` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` \| [`DID`](DID.md) | DID of the asset. | +| `metadataServiceEndpoint?` | `string` | - | #### Returns @@ -680,9 +680,9 @@ DDO of the asset. #### Defined in -[src/services/metadata/MetadataService.ts:258](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L258) +[src/services/metadata/MetadataService.ts:258](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L258) ---- +___ ### storeDDO @@ -692,8 +692,8 @@ Stores a DDO in Metadata. #### Parameters -| Name | Type | Description | -| :---- | :-------------- | :---------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `ddo` | [`DDO`](DDO.md) | DDO to be stored. | #### Returns @@ -704,9 +704,9 @@ Final DDO. #### Defined in -[src/services/metadata/MetadataService.ts:163](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L163) +[src/services/metadata/MetadataService.ts:163](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L163) ---- +___ ### storeService @@ -714,10 +714,10 @@ Final DDO. #### Parameters -| Name | Type | Description | -| :------------ | :------------------------------------------------------ | :--------------------------------------------- | -| `agreementId` | `string` | The agreement ID of the service. | -| `agreement` | [`ServiceSecondary`](../interfaces/ServiceSecondary.md) | Stores the Service object with its agreementId | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | The agreement ID of the service. | +| `agreement` | [`ServiceSecondary`](../interfaces/ServiceSecondary.md) | Stores the Service object with its agreementId | #### Returns @@ -727,9 +727,9 @@ the newly stored service object #### Defined in -[src/services/metadata/MetadataService.ts:321](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L321) +[src/services/metadata/MetadataService.ts:321](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L321) ---- +___ ### updateDDO @@ -739,10 +739,10 @@ Update a DDO in Metadata. #### Parameters -| Name | Type | Description | -| :---- | :-------------------------- | :---------------- | -| `did` | `string` \| [`DID`](DID.md) | - | -| `ddo` | [`DDO`](DDO.md) | DDO to be stored. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` \| [`DID`](DID.md) | - | +| `ddo` | [`DDO`](DDO.md) | DDO to be stored. | #### Returns @@ -752,9 +752,9 @@ Final DDO. #### Defined in -[src/services/metadata/MetadataService.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L132) +[src/services/metadata/MetadataService.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L132) ---- +___ ### getInstance @@ -762,8 +762,8 @@ Final DDO. #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -776,9 +776,9 @@ Final DDO. #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -786,15 +786,15 @@ Final DDO. #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -807,4 +807,4 @@ Final DDO. #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/MimcCipher.md b/docs/nevermined-sdk/api-reference/classes/MimcCipher.md index 53f545d2de..ea9caafe5b 100644 --- a/docs/nevermined-sdk/api-reference/classes/MimcCipher.md +++ b/docs/nevermined-sdk/api-reference/classes/MimcCipher.md @@ -25,10 +25,10 @@ #### Parameters -| Name | Type | -| :--- | :------- | -| `x` | `string` | -| `y` | `string` | +| Name | Type | +| :------ | :------ | +| `x` | `string` | +| `y` | `string` | #### Returns @@ -36,7 +36,7 @@ #### Defined in -[src/models/KeyTransfer.ts:23](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/KeyTransfer.ts#L23) +[src/models/KeyTransfer.ts:23](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/KeyTransfer.ts#L23) ## Properties @@ -46,9 +46,9 @@ #### Defined in -[src/models/KeyTransfer.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/KeyTransfer.ts#L20) +[src/models/KeyTransfer.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/KeyTransfer.ts#L20) ---- +___ ### y @@ -56,7 +56,7 @@ #### Defined in -[src/models/KeyTransfer.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/KeyTransfer.ts#L21) +[src/models/KeyTransfer.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/KeyTransfer.ts#L21) ## Methods @@ -70,4 +70,4 @@ #### Defined in -[src/models/KeyTransfer.ts:28](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/KeyTransfer.ts#L28) +[src/models/KeyTransfer.ts:28](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/KeyTransfer.ts#L28) diff --git a/docs/nevermined-sdk/api-reference/classes/NFT1155Api.md b/docs/nevermined-sdk/api-reference/classes/NFT1155Api.md index 69adf5060f..56e5f3c456 100644 --- a/docs/nevermined-sdk/api-reference/classes/NFT1155Api.md +++ b/docs/nevermined-sdk/api-reference/classes/NFT1155Api.md @@ -98,9 +98,9 @@ Allows the interaction with external ERC-1155 NFT contracts built on top of the #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L26) +[src/nevermined/api/nfts/NFT1155Api.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L26) ---- +___ ### servicePlugin @@ -116,7 +116,7 @@ Allows the interaction with external ERC-1155 NFT contracts built on top of the #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L39) +[src/nevermined/api/RegistryBaseApi.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L39) ## Accessors @@ -134,9 +134,9 @@ The NFT contract address #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:64](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L64) +[src/nevermined/api/nfts/NFT1155Api.ts:64](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L64) ---- +___ ### artifactsFolder @@ -152,9 +152,9 @@ NFTsBaseApi.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -170,9 +170,9 @@ NFTsBaseApi.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -188,9 +188,9 @@ NFTsBaseApi.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -206,9 +206,9 @@ NFTsBaseApi.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### getContract @@ -224,9 +224,9 @@ The `Nft1155Contract` instance #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:72](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L72) +[src/nevermined/api/nfts/NFT1155Api.ts:72](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L72) ---- +___ ### instanceConfig @@ -242,9 +242,9 @@ NFTsBaseApi.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -260,9 +260,9 @@ NFTsBaseApi.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -278,9 +278,9 @@ NFTsBaseApi.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -296,9 +296,9 @@ NFTsBaseApi.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -308,69 +308,69 @@ NFTsBaseApi.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -378,9 +378,9 @@ NFTsBaseApi.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -390,38 +390,38 @@ NFTsBaseApi.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -429,26 +429,26 @@ NFTsBaseApi.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods ### \_details -▸ **\_details**(`did`, `ercType`): `Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> +▸ **_details**(`did`, `ercType`): `Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> Get the details of an NFT #### Parameters -| Name | Type | Description | -| :-------- | :------------------------------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `ercType` | [`ERCType`](../enums/ERCType.md) | The type of NFT used | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `ercType` | [`ERCType`](../enums/ERCType.md) | The type of NFT used | #### Returns -`Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> +`Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> The details of the NFT. @@ -468,13 +468,13 @@ assert.equal(details.owner, artist.getId()) #### Inherited from -[NFTsBaseApi](NFTsBaseApi.md).[\_details](NFTsBaseApi.md#_details) +[NFTsBaseApi](NFTsBaseApi.md).[_details](NFTsBaseApi.md#_details) #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:152](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L152) +[src/nevermined/api/nfts/NFTsBaseApi.ts:152](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L152) ---- +___ ### access @@ -484,16 +484,16 @@ Access the files associated with an NFT. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------------------------------ | -| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The user account holding NFTs (after purchase) requesting the access | -| `destination?` | `string` | `undefined` | The download destination for the files. | -| `fileIndex?` | `number` | `undefined` | The index of the file. If unset will download all the files in the asset. | -| `agreementId` | `string` | `'0x'` | The NFT sales agreement id. | -| `buyer?` | `string` | `undefined` | Key which represent the buyer | -| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | - | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service reference to use. By default is nft-access. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The user account holding NFTs (after purchase) requesting the access | +| `destination?` | `string` | `undefined` | The download destination for the files. | +| `fileIndex?` | `number` | `undefined` | The index of the file. If unset will download all the files in the asset. | +| `agreementId` | `string` | `'0x'` | The NFT sales agreement id. | +| `buyer?` | `string` | `undefined` | Key which represent the buyer | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | - | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service reference to use. By default is nft-access. | #### Returns @@ -518,9 +518,9 @@ const result = await nevermined.nfts1155.access(ddo.id, collector, '/tmp/') #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:427](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L427) +[src/nevermined/api/nfts/NFTsBaseApi.ts:427](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L427) ---- +___ ### addRating @@ -530,14 +530,14 @@ Given a DID, it adds a vote to the asset curation information. #### Parameters -| Name | Type | Default value | Description | -| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `newRating` | `number` | `undefined` | New average rating of the asset | -| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `newRating` | `number` | `undefined` | New average rating of the asset | +| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -551,9 +551,9 @@ Given a DID, it adds a vote to the asset curation information. #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:534](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L534) +[src/nevermined/api/RegistryBaseApi.ts:534](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L534) ---- +___ ### balance @@ -563,10 +563,10 @@ Get the NFT balance for a particular did associated to an account/address #### Parameters -| Name | Type | Description | -| :-------- | :---------------------------------------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `account` | `string` \| [`NvmAccount`](NvmAccount.md) | The account/address to check the balance of. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `account` | `string` \| [`NvmAccount`](NvmAccount.md) | The account/address to check the balance of. | #### Returns @@ -582,9 +582,9 @@ const balance = await nevermined.nfts1155.balance(ddo.id, artist) #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:464](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L464) +[src/nevermined/api/nfts/NFT1155Api.ts:464](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L464) ---- +___ ### burn @@ -594,12 +594,12 @@ It burns NFTs associated with an asset. #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :---------------------------------------------------------------- | -| `tokenId` | `string` | The Decentralized Identifier of the NFT asset. | -| `nftAmount` | `bigint` | The amount of NFTs to burn. | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the publisher of the NFT with permissions to burn. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `tokenId` | `string` | The Decentralized Identifier of the NFT asset. | +| `nftAmount` | `bigint` | The amount of NFTs to burn. | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the publisher of the NFT with permissions to burn. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -614,14 +614,18 @@ The publisher can only burn NFTs that it owns. NFTs that were already transferre **`Example`** ```ts -await nevermined.nfts1155.burn(did, 2n, artist) +await nevermined.nfts1155.burn( + did, + 2n, + artist +) ``` #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:189](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L189) +[src/nevermined/api/nfts/NFT1155Api.ts:189](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L189) ---- +___ ### burnFromHolder @@ -631,13 +635,13 @@ Burns NFTs associated with an asset of a specific account. #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :---------------------------------------------- | -| `holder` | `string` | The address of the account that holds the NFTs. | -| `tokenId` | `string` | The TokenId of the NFT | -| `nftAmount` | `bigint` | The amount of NFTs to burn. | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the publisher of the NFT. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `holder` | `string` | The address of the account that holds the NFTs. | +| `tokenId` | `string` | The TokenId of the NFT | +| `nftAmount` | `bigint` | The amount of NFTs to burn. | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the publisher of the NFT. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -652,14 +656,19 @@ The publisher can only burn NFTs of an account if is an operator. NFTs that were **`Example`** ```ts -await nevermined.nfts1155.burnTo(holder, tokenId, 2n, artist) +await nevermined.nfts1155.burnTo( + holder, + tokenId, + 2n, + artist +) ``` #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:217](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L217) +[src/nevermined/api/nfts/NFT1155Api.ts:217](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L217) ---- +___ ### buySecondaryMarketNft @@ -669,13 +678,13 @@ Buys a number of listed NFTs on secondary markets. #### Parameters -| Name | Type | Description | -| :------------------ | :---------------------------------------------- | :--------------------------------------------------------- | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the buyer/consumer. | -| `nftAmount` | `bigint` | The number of assets to buy. 1 by default. | -| `agreementIdSeed` | `string` | The seed of the initial sales agreement created off-chain. | -| `conditionsTimeout` | `number`[] | The timeout for the conditions. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the buyer/consumer. | +| `nftAmount` | `bigint` | The number of assets to buy. 1 by default. | +| `agreementIdSeed` | `string` | The seed of the initial sales agreement created off-chain. | +| `conditionsTimeout` | `number`[] | The timeout for the conditions. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -686,7 +695,11 @@ true if the buy was successful. **`Example`** ```ts -const result = await nevermined.nfts1155.buySecondaryMarketNft(collector, 1n, agreementId) +const result = await nevermined.nfts1155.buySecondaryMarketNft( + collector, + 1n, + agreementId + ) ``` **`Throws`** @@ -700,9 +713,9 @@ Thrown if there is an error buying the NFT. #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:345](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L345) +[src/nevermined/api/nfts/NFTsBaseApi.ts:345](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L345) ---- +___ ### claim @@ -712,14 +725,14 @@ Claims the transfer of a NFT to the Nevermined Node on behalf of the publisher. #### Parameters -| Name | Type | Description | -| :--------------- | :------- | :---------------------------------------------------------------------------- | -| `agreementId` | `string` | The NFT sales agreement id. | -| `nftHolder` | `string` | The address of the current owner of the NFT. | -| `nftReceiver` | `string` | The address where the NFT should be transferred. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | The NFT sales agreement id. | +| `nftHolder` | `string` | The address of the current owner of the NFT. | +| `nftReceiver` | `string` | The address where the NFT should be transferred. | | `numberEditions` | `bigint` | The number of NFT editions to transfer. If the NFT is ERC-1155 it should be 1 | -| `did?` | `string` | The Decentralized Identifier of the asset. | -| `serviceIndex?` | `number` | The index of the service in the DDO that will be claimed | +| `did?` | `string` | The Decentralized Identifier of the asset. | +| `serviceIndex?` | `number` | The index of the service in the DDO that will be claimed | #### Returns @@ -740,19 +753,19 @@ as soon as the payment is made ```ts const receipt = await nevermined.nfts1155.claim( - agreementId, - publisherAddress, - subscriberAddress, - 1n, - did, -) + agreementId, + publisherAddress, + subscriberAddress, + 1n, + did + ) ``` #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:320](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L320) +[src/nevermined/api/nfts/NFT1155Api.ts:320](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L320) ---- +___ ### claimNFT @@ -762,15 +775,15 @@ Claims the transfer of a NFT to the Nevermined Node on behalf of the publisher. #### Parameters -| Name | Type | Default value | Description | -| :--------------- | :------------------------------- | :------------ | :--------------------------------------------------------------------------- | -| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | -| `nftHolder` | `string` | `undefined` | The address of the current owner of the NFT. | -| `nftReceiver` | `string` | `undefined` | The address where the NFT should be transferred. | -| `numberEditions` | `bigint` | `undefined` | The number of NFT editions to transfer. If the NFT is ERC-721 it should be 1 | -| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The Type of the NFT ERC (1155 or 721). | -| `did?` | `string` | `undefined` | The DID of the asset. | -| `serviceIndex?` | `number` | `undefined` | The index of the service in the DDO that will be claimed | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `nftHolder` | `string` | `undefined` | The address of the current owner of the NFT. | +| `nftReceiver` | `string` | `undefined` | The address where the NFT should be transferred. | +| `numberEditions` | `bigint` | `undefined` | The number of NFT editions to transfer. If the NFT is ERC-721 it should be 1 | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The Type of the NFT ERC (1155 or 721). | +| `did?` | `string` | `undefined` | The DID of the asset. | +| `serviceIndex?` | `number` | `undefined` | The index of the service in the DDO that will be claimed | #### Returns @@ -791,12 +804,12 @@ as soon as the payment is made ```ts const receipt = await nevermined.nfts721.claim( - agreementId, - editor.getId(), - subscriber.getId(), - nftAmount, - 721, -) + agreementId, + editor.getId(), + subscriber.getId(), + nftAmount, + 721 + ) ``` **`Throws`** @@ -809,9 +822,9 @@ const receipt = await nevermined.nfts721.claim( #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L52) +[src/nevermined/api/nfts/NFTsBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L52) ---- +___ ### create @@ -821,12 +834,12 @@ Creates a new Nevermined asset associated to a NFT (ERC-1155). #### Parameters -| Name | Type | Description | -| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | -| `nftAttributes` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-1155) associated to the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | +| Name | Type | Description | +| :------ | :------ | :------ | +| `nftAttributes` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-1155) associated to the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | | `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -838,19 +851,22 @@ The newly registered [DDO](DDO.md). ```ts const assetAttributes = AssetAttributes.getInstance({ - metadata, - price: assetPrice, - serviceTypes: ['nft-sales', 'nft-access'], -}) + metadata, + price: assetPrice, + serviceTypes: ['nft-sales', 'nft-access'] + }) const nftAttributes = NFTAttributes.getNFT1155Instance({ - ...assetAttributes, - nftContractAddress: nftUpgradeable.address, - cap: cappedAmount, - amount: numberNFTs, - royaltyAttributes, - preMint, -}) -const ddo = await nevermined.nfts1155.create(nftAttributes, publisher) + ...assetAttributes, + nftContractAddress: nftUpgradeable.address, + cap: cappedAmount, + amount: numberNFTs, + royaltyAttributes, + preMint + }) +const ddo = await nevermined.nfts1155.create( + nftAttributes, + publisher + ) ``` **`See`** @@ -859,25 +875,25 @@ const ddo = await nevermined.nfts1155.create(nftAttributes, publisher) #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:107](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L107) +[src/nevermined/api/nfts/NFT1155Api.ts:107](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L107) ---- +___ ### details -▸ **details**(`did`): `Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> +▸ **details**(`did`): `Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> Get the details of a NFT #### Parameters -| Name | Type | Description | -| :---- | :------- | :--------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `did` | `string` | The Decentralized Identifier of the NFT asset. | #### Returns -`Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> +`Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> The details of the NFT. @@ -897,9 +913,9 @@ assert.equal(details.owner, artist.getId()) #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:676](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L676) +[src/nevermined/api/nfts/NFT1155Api.ts:676](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L676) ---- +___ ### getSubscriptionToken @@ -909,10 +925,10 @@ Get a JWT token for an asset associated with a webService #### Parameters -| Name | Type | Description | -| :----- | :---------------------------- | :----------------------------------------------------------------------------- | -| `did` | `string` | The did of the asset with a webService resource and an associated subscription | -| `from` | [`NvmAccount`](NvmAccount.md) | Account of the user requesting the token | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The did of the asset with a webService resource and an associated subscription | +| `from` | [`NvmAccount`](NvmAccount.md) | Account of the user requesting the token | #### Returns @@ -935,9 +951,9 @@ assert.isDefined(response.neverminedProxyUri) #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:490](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L490) +[src/nevermined/api/nfts/NFTsBaseApi.ts:490](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L490) ---- +___ ### grantOperatorRole @@ -948,11 +964,11 @@ Granting and revoking minting permissions only can be done by the NFT Contract o #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :--------------------------------------------------------------------- | -| `operatorAddress` | `string` | The address of the account to be added as operator in the NFT Contract | -| `from` | [`NvmAccount`](NvmAccount.md) | The account giving operator permissions | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | The address of the account to be added as operator in the NFT Contract | +| `from` | [`NvmAccount`](NvmAccount.md) | The account giving operator permissions | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -963,14 +979,17 @@ The TransactionReceipt **`Example`** ```ts -await nevermined.nfts1155.grantOperatorRole(someoneElse, artist) +await nevermined.nfts1155.grantOperatorRole( + someoneElse, + artist +) ``` #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:622](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L622) +[src/nevermined/api/nfts/NFT1155Api.ts:622](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L622) ---- +___ ### isApprovedForAll @@ -980,10 +999,10 @@ Returns if the `operatorAddress` is approved #### Parameters -| Name | Type | Description | -| :---------------- | :------- | :--------------------------------------------------------------------------------------- | -| `operatorAddress` | `string` | The address to check the permissions | -| `from` | `string` | The address of the account granting or revoking the permissions via `setApprovalForAll`. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | The address to check the permissions | +| `from` | `string` | The address of the account granting or revoking the permissions via `setApprovalForAll`. | #### Returns @@ -1003,9 +1022,9 @@ await nevermined.nfts1155.isApprovedForAll(someoneElse, artist.getId()) #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:538](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L538) +[src/nevermined/api/nfts/NFT1155Api.ts:538](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L538) ---- +___ ### isOperator @@ -1015,11 +1034,11 @@ Check if a particular address is the operator of given a NFT address. #### Parameters -| Name | Type | Default value | Description | -| :------------------- | :------------------------------- | :------------ | :-------------------------------------- | -| `nftContractAddress` | `string` | `undefined` | The DID of the NFT to check | -| `operatorAddress` | `string` | `undefined` | The address to check if operator status | -| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `nftContractAddress` | `string` | `undefined` | The DID of the NFT to check | +| `operatorAddress` | `string` | `undefined` | The address to check if operator status | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | #### Returns @@ -1033,9 +1052,9 @@ operator status of address as a boolean #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:118](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L118) +[src/nevermined/api/nfts/NFTsBaseApi.ts:118](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L118) ---- +___ ### isOperatorOfDID @@ -1045,11 +1064,11 @@ Check if a particular address is the operator of a DID. #### Parameters -| Name | Type | Default value | Description | -| :-------- | :------------------------------- | :------------ | :-------------------------------------- | -| `did` | `string` | `undefined` | The DID of the NFT to check | -| `address` | `string` | `undefined` | The address to check if operator status | -| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | The DID of the NFT to check | +| `address` | `string` | `undefined` | The address to check if operator status | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | #### Returns @@ -1063,9 +1082,9 @@ operator status of address as a boolean #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:93](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L93) +[src/nevermined/api/nfts/NFTsBaseApi.ts:93](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L93) ---- +___ ### list @@ -1076,13 +1095,13 @@ In a Nevermined environment, when an asset is unlisted, it is not possible to be #### Parameters -| Name | Type | Default value | Description | -| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -1096,9 +1115,9 @@ In a Nevermined environment, when an asset is unlisted, it is not possible to be #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:482](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L482) +[src/nevermined/api/RegistryBaseApi.ts:482](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L482) ---- +___ ### listOnSecondaryMarkets @@ -1108,15 +1127,15 @@ After purchase re-list an NFT to enable secondary market sales. #### Parameters -| Name | Type | Description | -| :------------ | :---------------------------- | :----------------------------------------------------------- | -| `ddo` | [`DDO`](DDO.md) | The DDO of the asset. | -| `assetPrice` | [`AssetPrice`](AssetPrice.md) | The current setup of asset rewards. | -| `nftAmount` | `bigint` | The number of NFTs put up for secondary sale. | -| `nftTransfer` | `boolean` | - | -| `provider` | `string` | The address that will be the provider of the secondary sale. | -| `token` | [`Token`](Token.md) | - | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the current owner. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | The DDO of the asset. | +| `assetPrice` | [`AssetPrice`](AssetPrice.md) | The current setup of asset rewards. | +| `nftAmount` | `bigint` | The number of NFTs put up for secondary sale. | +| `nftTransfer` | `boolean` | - | +| `provider` | `string` | The address that will be the provider of the secondary sale. | +| `token` | [`Token`](Token.md) | - | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the current owner. | #### Returns @@ -1128,13 +1147,13 @@ the agreementId of the secondary sale. ```ts const agreementId = await nevermined.nfts1155.listOnSecondaryMarkets( - ddo, - assetPrice, - numberNFTs, - collector.getId(), - token, - collector.getId(), -) + ddo, + assetPrice, + numberNFTs, + collector.getId(), + token, + collector.getId() + ) ``` **`Throws`** @@ -1148,9 +1167,9 @@ Thrown if there is an error listing the NFT. #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:262](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L262) +[src/nevermined/api/nfts/NFTsBaseApi.ts:262](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L262) ---- +___ ### mint @@ -1160,14 +1179,14 @@ It mints the NFTs associated with an asset. #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :-------------------------------------------------------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `nftAmount` | `bigint` | The amount of NFTs to mint. | -| `receiver` | `undefined` \| `string` | Account address of the NFT receiver, if `undefined` the minter account will receive the NFT/s | -| `from` | [`NvmAccount`](NvmAccount.md) | The account minting the NFT. \* | -| `data?` | `string` | Data | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `nftAmount` | `bigint` | The amount of NFTs to mint. | +| `receiver` | `undefined` \| `string` | Account address of the NFT receiver, if `undefined` the minter account will receive the NFT/s | +| `from` | [`NvmAccount`](NvmAccount.md) | The account minting the NFT. * | +| `data?` | `string` | Data | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -1182,14 +1201,18 @@ This function can be called multiple times as long as the minting does not excee **`Example`** ```ts -await nevermined.nfts1155.mint(did, 10n, artist) +await nevermined.nfts1155.mint( + did, + 10n, + artist +) ``` #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L149) +[src/nevermined/api/nfts/NFT1155Api.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L149) ---- +___ ### order @@ -1199,13 +1222,13 @@ It orders NFTs. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------ | :------------------------------------------------------------- | -| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | -| `numberEditions` | `bigint` | `undefined` | The amount of NFTs to buy. | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account of the NFT buyer. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | +| `numberEditions` | `bigint` | `undefined` | The amount of NFTs to buy. | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account of the NFT buyer. | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to order | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | #### Returns @@ -1226,9 +1249,9 @@ agreementId = await nevermined.nfts1155.order(ddo.id, numberNFTs, collector) #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:250](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L250) +[src/nevermined/api/nfts/NFT1155Api.ts:250](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L250) ---- +___ ### orderAsset @@ -1239,12 +1262,12 @@ then sends the request to the publisher via the service endpoint (Node http serv #### Parameters -| Name | Type | Description | -| :----------------- | :------------------------------------------------------------ | :--------------------- | -| `did` | `string` | Decentralized ID. | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | -| `from` | [`NvmAccount`](NvmAccount.md) | Consumer account. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | Decentralized ID. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `from` | [`NvmAccount`](NvmAccount.md) | Consumer account. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -1258,9 +1281,9 @@ The agreement ID. #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:585](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L585) +[src/nevermined/api/RegistryBaseApi.ts:585](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L585) ---- +___ ### owner @@ -1277,14 +1300,16 @@ Address of the contract owner **`Example`** ```ts -const nftContractOwner = new NvmAccount(await nevermined.nfts1155.owner()) +const nftContractOwner = new NvmAccount( + await nevermined.nfts1155.owner() +) ``` #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:483](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L483) +[src/nevermined/api/nfts/NFT1155Api.ts:483](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L483) ---- +___ ### registerNeverminedAsset @@ -1295,13 +1320,13 @@ via the Nevermined APIs directly. It must accessed via the `assets`, `compute`, #### Parameters -| Name | Type | Description | -| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | -| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | +| Name | Type | Description | +| :------ | :------ | :------ | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | | `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -1319,9 +1344,9 @@ The metadata of the asset created (DDO) #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L52) +[src/nevermined/api/RegistryBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L52) ---- +___ ### releaseRewards @@ -1331,14 +1356,14 @@ Release the funds from escrow. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------ | :----------------------------------------------------------------------- | -| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | -| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to release rewards | -| `nftAmount` | `bigint` | `undefined` | The amount of NFTs to transfer. | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The current owner of the NFTs. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | +| `nftAmount` | `bigint` | `undefined` | The amount of NFTs to transfer. | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The current owner of the NFTs. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | #### Returns @@ -1353,7 +1378,12 @@ A publisher is able to release the funds put on escrow by the consumer after tra **`Example`** ```ts -const receipt = await nevermined.nfts1155.releaseRewards(agreementId, ddo.id, numberNFTs, artist) +const receipt = await nevermined.nfts1155.releaseRewards( + agreementId, + ddo.id, + numberNFTs, + artist + ) ``` **`Throws`** @@ -1363,9 +1393,9 @@ Thrown if there is an error releasing the rewards #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:423](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L423) +[src/nevermined/api/nfts/NFT1155Api.ts:423](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L423) ---- +___ ### releaseSecondaryMarketRewards @@ -1375,13 +1405,13 @@ Used to release the secondary market NFT & the locked rewards. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------ | :----------------------------------------------------------------------- | -| `owner` | [`NvmAccount`](NvmAccount.md) | `undefined` | The owner account. | -| `consumer` | [`NvmAccount`](NvmAccount.md) | `undefined` | The consumer account. | -| `agreementIdSeed` | `string` | `undefined` | the Id of the underlying service agreement seed. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `owner` | [`NvmAccount`](NvmAccount.md) | `undefined` | The owner account. | +| `consumer` | [`NvmAccount`](NvmAccount.md) | `undefined` | The consumer account. | +| `agreementIdSeed` | `string` | `undefined` | the Id of the underlying service agreement seed. | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to release rewards | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | #### Returns @@ -1402,9 +1432,9 @@ Thrown if there is an error releasing the rewards. #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:560](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L560) +[src/nevermined/api/nfts/NFT1155Api.ts:560](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L560) ---- +___ ### resolveAsset @@ -1415,9 +1445,9 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Parameters -| Name | Type | Default value | Description | -| :------- | :------------------------------------------------- | :---------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID. | | `policy` | [`DIDResolvePolicy`](../enums/DIDResolvePolicy.md) | `DIDResolvePolicy.MetadataAPIFirst` | It specifies the resolve policy to apply. It allows to select that priorities during the asset resolution via Metadata API or Immutable URLs (IPFS, Filecoin, etc) | #### Returns @@ -1432,9 +1462,9 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:324](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L324) +[src/nevermined/api/RegistryBaseApi.ts:324](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L324) ---- +___ ### revokeOperatorRole @@ -1445,11 +1475,11 @@ Granting and revoking minting permissions only can be done by the NFT Contract o #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :----------------------------------------------------------------------- | -| `operatorAddress` | `string` | The address of the account to be revoked as operator in the NFT Contract | -| `from` | [`NvmAccount`](NvmAccount.md) | The account revoking operator permissions | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | The address of the account to be revoked as operator in the NFT Contract | +| `from` | [`NvmAccount`](NvmAccount.md) | The account revoking operator permissions | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -1460,14 +1490,17 @@ The TransactionReceipt **`Example`** ```ts -await nevermined.nfts1155.revokeOperatorRole(someoneElse, artist) +await nevermined.nfts1155.revokeOperatorRole( + someoneElse, + artist +) ``` #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:648](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L648) +[src/nevermined/api/nfts/NFT1155Api.ts:648](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L648) ---- +___ ### setApprovalForAll @@ -1477,12 +1510,12 @@ Enable or disable NFT permissions for an operator. #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :------------------------------------------------------------------- | -| `operatorAddress` | `string` | The address that of the operator we want to give transfer rights to. | -| `approved` | `boolean` | Give or remove transfer rights from the operator. | -| `from` | [`NvmAccount`](NvmAccount.md) | The account that wants to give transfer rights to the operator. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | The address that of the operator we want to give transfer rights to. | +| `approved` | `boolean` | Give or remove transfer rights from the operator. | +| `from` | [`NvmAccount`](NvmAccount.md) | The account that wants to give transfer rights to the operator. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | #### Returns @@ -1497,14 +1530,18 @@ The TransactionReceipt **`Example`** ```ts -await nevermined.nfts1155.setApprovalForAll(someoneElse, true, artist) +await nevermined.nfts1155.setApprovalForAll( + someoneElse, + true, + artist +) ``` #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:508](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L508) +[src/nevermined/api/nfts/NFT1155Api.ts:508](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L508) ---- +___ ### setInstanceConfig @@ -1512,8 +1549,8 @@ await nevermined.nfts1155.setApprovalForAll(someoneElse, true, artist) #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1526,9 +1563,9 @@ await nevermined.nfts1155.setApprovalForAll(someoneElse, true, artist) #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### transfer @@ -1538,14 +1575,14 @@ Transfer NFTs to the consumer. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------ | :---------------------------------------------------------------- | -| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | -| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | -| `nftAmount` | `bigint` | `undefined` | The number of NFTs to transfer. | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The current owner of the NFTs. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | +| `nftAmount` | `bigint` | `undefined` | The number of NFTs to transfer. | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The current owner of the NFTs. | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to transfer | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | #### Returns @@ -1561,7 +1598,12 @@ execute the transfer in order to be able to release the rewards. **`Example`** ```ts -const receipt = await nevermined.nfts1155.transfer(agreementId, ddo.id, numberNFTs, artist) +const receipt = await nevermined.nfts1155.transfer( + agreementId, + ddo.id, + numberNFTs, + artist + ) ``` **`Throws`** @@ -1571,9 +1613,9 @@ Thrown if there is an error transferring the NFT #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:367](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L367) +[src/nevermined/api/nfts/NFT1155Api.ts:367](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L367) ---- +___ ### updateAsset @@ -1583,13 +1625,13 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Parameters -| Name | Type | Default value | Description | -| :----------------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -1603,9 +1645,9 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:367](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L367) +[src/nevermined/api/RegistryBaseApi.ts:367](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L367) ---- +___ ### getInstance @@ -1615,11 +1657,11 @@ Create a new Nevermined NFTs (ERC-1155) instance allowing to interact with that #### Parameters -| Name | Type | Description | -| :--------------------- | :---------------------------------------------------------- | :---------------------------------------------------------------------------------- | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | The Nevermined config | -| `nftContractInstance?` | [`Nft1155Contract`](Nft1155Contract.md) | If there is already deployed an instance of `Nft1155Contract` | -| `nftContractAddress?` | `string` | If the `Nft1155Contract` is deployed in an address it will connect to that contract | +| Name | Type | Description | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | The Nevermined config | +| `nftContractInstance?` | [`Nft1155Contract`](Nft1155Contract.md) | If there is already deployed an instance of `Nft1155Contract` | +| `nftContractAddress?` | `string` | If the `Nft1155Contract` is deployed in an address it will connect to that contract | #### Returns @@ -1630,7 +1672,10 @@ The NFTs 1155 API instance [NFT1155Api](NFT1155Api.md). **`Example`** ```ts -nfts1155 = await Nft1155Api.getInstance(instanceConfig, nft1155Contract) +nfts1155 = await Nft1155Api.getInstance( + instanceConfig, + nft1155Contract +) ``` #### Overrides @@ -1639,9 +1684,9 @@ nfts1155 = await Nft1155Api.getInstance(instanceConfig, nft1155Contract) #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L44) +[src/nevermined/api/nfts/NFT1155Api.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L44) ---- +___ ### getNFTContractAddress @@ -1651,9 +1696,9 @@ Gets the NFT contract address associated with a Nevermined asset from the DDO. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------ | -| `ddo` | [`DDO`](DDO.md) | `undefined` | The DDO of the asset. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | `undefined` | The DDO of the asset. | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service type to look for the contract address | #### Returns @@ -1674,9 +1719,9 @@ const nftContractAddress = NFT1155Api.getNFTContractAddress(ddo) #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:221](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L221) +[src/nevermined/api/nfts/NFTsBaseApi.ts:221](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L221) ---- +___ ### getServicePlugin @@ -1686,8 +1731,8 @@ Initializes the default Nevermined service plugins and return that instance #### Parameters -| Name | Type | Description | -| :------- | :---------------------------------------------------------- | :---------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Nevermined config | #### Returns @@ -1696,12 +1741,12 @@ Initializes the default Nevermined service plugins and return that instance The Nevermined Service Plugin instance -| Name | Type | -| :----------- | :-------------------------------------------------------------------- | -| `access` | [`AccessService`](AccessService.md) | -| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | -| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | -| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | +| Name | Type | +| :------ | :------ | +| `access` | [`AccessService`](AccessService.md) | +| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | +| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | +| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | #### Inherited from @@ -1709,9 +1754,9 @@ The Nevermined Service Plugin instance #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:640](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L640) +[src/nevermined/api/RegistryBaseApi.ts:640](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L640) ---- +___ ### setInstanceConfig @@ -1719,15 +1764,15 @@ The Nevermined Service Plugin instance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1740,4 +1785,4 @@ The Nevermined Service Plugin instance #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/NFT721AccessTemplate.md b/docs/nevermined-sdk/api-reference/classes/NFT721AccessTemplate.md index d2d1785f07..0a6ddb58f4 100644 --- a/docs/nevermined-sdk/api-reference/classes/NFT721AccessTemplate.md +++ b/docs/nevermined-sdk/api-reference/classes/NFT721AccessTemplate.md @@ -91,8 +91,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -105,7 +105,7 @@ #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) ## Properties @@ -119,9 +119,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -133,9 +133,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -147,9 +147,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -161,9 +161,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -175,7 +175,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -193,9 +193,9 @@ BaseTemplate.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -211,9 +211,9 @@ BaseTemplate.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -229,9 +229,9 @@ BaseTemplate.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -247,9 +247,9 @@ BaseTemplate.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -265,9 +265,9 @@ BaseTemplate.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -283,9 +283,9 @@ BaseTemplate.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -301,9 +301,9 @@ BaseTemplate.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -319,9 +319,9 @@ BaseTemplate.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -331,69 +331,69 @@ BaseTemplate.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -401,9 +401,9 @@ BaseTemplate.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -413,38 +413,38 @@ BaseTemplate.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -452,7 +452,7 @@ BaseTemplate.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -462,8 +462,8 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :------- | :------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | #### Returns @@ -476,9 +476,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:106](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L106) +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:106](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L106) ---- +___ ### agreementId @@ -486,10 +486,10 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `agreementIdSeed` | `string` | -| `creator` | `string` | +| `creator` | `string` | #### Returns @@ -501,9 +501,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L202) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L202) ---- +___ ### call @@ -512,16 +512,16 @@ BaseTemplate.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -533,9 +533,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### conditions @@ -551,9 +551,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:54](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L54) +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:54](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L54) ---- +___ ### createAgreement @@ -561,16 +561,16 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `extraArgs` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `extraArgs` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -582,9 +582,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L73) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L73) ---- +___ ### createAgreementAndPay @@ -592,21 +592,21 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :--------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `accessConsumer` | `string` | -| `condIdx` | `number` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `bigint`[] | -| `receivers` | `string`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `accessConsumer` | `string` | +| `condIdx` | `number` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -618,9 +618,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L98) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L98) ---- +___ ### createAgreementFromDDO @@ -630,14 +630,14 @@ Create a new agreement using the data of a DDO. #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :---------- | -| `agreementIdSeed` | `string` | - | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `parameters` | `NFT721AccessTemplateParams` | | -| `consumer` | [`NvmAccount`](NvmAccount.md) | - | -| `timeOuts?` | `number`[] | - | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementIdSeed` | `string` | - | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `parameters` | `NFT721AccessTemplateParams` | | +| `consumer` | [`NvmAccount`](NvmAccount.md) | - | +| `timeOuts?` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | #### Returns @@ -651,9 +651,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L211) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L211) ---- +___ ### createAgreementWithPaymentFromDDO @@ -661,16 +661,16 @@ true if the call was successful. #### Parameters -| Name | Type | -| :----------------- | :------------------------------------------------------------------------------------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | -| `parameters` | `NFT721AccessTemplateParams` | -| `consumer` | [`NvmAccount`](NvmAccount.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | -| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | +| Name | Type | +| :------ | :------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `NFT721AccessTemplateParams` | +| `consumer` | [`NvmAccount`](NvmAccount.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | #### Returns @@ -682,9 +682,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L240) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L240) ---- +___ ### createService @@ -692,13 +692,13 @@ true if the call was successful. #### Parameters -| Name | Type | -| :------------------ | :---------------------------------------------------------------------------- | -| `publisher` | [`NvmAccount`](NvmAccount.md) | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | -| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | -| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | +| Name | Type | +| :------ | :------ | +| `publisher` | [`NvmAccount`](NvmAccount.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | #### Returns @@ -710,9 +710,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L48) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L48) ---- +___ ### description @@ -728,9 +728,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L39) +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L39) ---- +___ ### extraGen @@ -738,8 +738,8 @@ true if the call was successful. #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | #### Returns @@ -752,9 +752,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) ---- +___ ### getAgreementCreatedEvent @@ -764,8 +764,8 @@ Generates and returns the agreement creation event. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns @@ -780,23 +780,23 @@ Agreement created event. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L450) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L450) ---- +___ ### getAgreementData -▸ **getAgreementData**(`agreementId`): `Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> +▸ **getAgreementData**(`agreementId`): `Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns -`Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> +`Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> #### Inherited from @@ -804,9 +804,9 @@ Agreement created event. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L29) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L29) ---- +___ ### getAgreementIdsFromDDO @@ -816,12 +816,12 @@ Get agreement conditions IDs. #### Parameters -| Name | Type | Description | -| :------------ | :--------------------------- | :------------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `NFT721AccessTemplateParams` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | Agreement ID. | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `creator` | `string` | - | +| `params` | `NFT721AccessTemplateParams` | - | #### Returns @@ -835,25 +835,25 @@ The condition IDs. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L169) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L169) ---- +___ ### getAgreementStatus -▸ **getAgreementStatus**(`agreementId`): `Promise`\<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> +▸ **getAgreementStatus**(`agreementId`): `Promise`\<``false`` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> Returns the status of the conditions. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns -`Promise`\<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> +`Promise`\<``false`` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> The conditions status. @@ -863,9 +863,9 @@ The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L331) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L331) ---- +___ ### getAgreementsForDID @@ -873,8 +873,8 @@ The conditions status. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -887,9 +887,9 @@ The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L476) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L476) ---- +___ ### getConditionTypes @@ -909,9 +909,9 @@ A list of condition addresses. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L137) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L137) ---- +___ ### getConditions @@ -931,9 +931,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L148) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L148) ---- +___ ### getFromAddress @@ -941,8 +941,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -955,9 +955,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getServiceAgreementTemplate @@ -973,9 +973,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:83](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L83) +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:83](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L83) ---- +___ ### getServiceAgreementTemplateConditionByRef @@ -983,8 +983,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `ref` | `string` | #### Returns @@ -997,9 +997,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L314) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L314) ---- +___ ### getServiceAgreementTemplateConditions @@ -1015,17 +1015,17 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L309) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L309) ---- +___ ### getServiceAgreementTemplateDependencies -▸ **getServiceAgreementTemplateDependencies**(): `Promise`\<\{ `[condition: string]`: `string`[]; }\> +▸ **getServiceAgreementTemplateDependencies**(): `Promise`\<\{ `[condition: string]`: `string`[]; }\> #### Returns -`Promise`\<\{ `[condition: string]`: `string`[]; }\> +`Promise`\<\{ `[condition: string]`: `string`[]; }\> #### Inherited from @@ -1033,24 +1033,24 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L321) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L321) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -1058,9 +1058,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -1068,11 +1068,11 @@ A list of condition contracts. #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -1084,9 +1084,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instanceFromDDO @@ -1094,12 +1094,12 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :---------------- | :--------------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `NFT721AccessTemplateParams` | +| Name | Type | +| :------ | :------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `parameters` | `NFT721AccessTemplateParams` | #### Returns @@ -1111,9 +1111,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:59](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L59) +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:59](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L59) ---- +___ ### lockConditionIndex @@ -1129,9 +1129,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L57) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L57) ---- +___ ### lockTokens @@ -1139,12 +1139,12 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `tokenAddress` | `any` | +| `amounts` | `any` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1156,9 +1156,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L382) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L382) ---- +___ ### name @@ -1174,9 +1174,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:36](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L36) +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:36](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L36) ---- +___ ### params @@ -1184,8 +1184,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :-------------- | :------- | +| Name | Type | +| :------ | :------ | | `holderAddress` | `string` | #### Returns @@ -1198,9 +1198,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:50](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L50) +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:50](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L50) ---- +___ ### paramsGen @@ -1210,8 +1210,8 @@ Specialize params #### Parameters -| Name | Type | Description | -| :--------------- | :------------------------------------------------------ | :----------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `«destructured»` | [`ValidationParams`](../interfaces/ValidationParams.md) | Generic parameters | #### Returns @@ -1224,9 +1224,9 @@ Specialize params #### Defined in -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:28](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L28) +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:28](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L28) ---- +___ ### paymentData @@ -1234,8 +1234,8 @@ Specialize params #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | #### Returns @@ -1248,9 +1248,9 @@ Specialize params #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L61) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L61) ---- +___ ### printAgreementStatus @@ -1260,8 +1260,8 @@ Prints the agreement status. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns @@ -1274,9 +1274,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L418) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L418) ---- +___ ### process @@ -1284,11 +1284,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :---------- | :------------------------------------------------------ | -| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1300,9 +1300,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:126](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L126) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:126](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L126) ---- +___ ### send @@ -1310,12 +1310,12 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1327,9 +1327,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -1337,12 +1337,12 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1354,9 +1354,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### service @@ -1372,9 +1372,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:43](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L43) +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:43](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L43) ---- +___ ### serviceEndpoint @@ -1390,9 +1390,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:46](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L46) +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:46](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L46) ---- +___ ### setInstanceConfig @@ -1400,8 +1400,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1414,9 +1414,9 @@ Prints the agreement status. #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1424,8 +1424,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1438,9 +1438,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### standardContext @@ -1448,11 +1448,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :-------------- | :-------------- | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `serviceIndex?` | `number` | +| Name | Type | +| :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `serviceIndex?` | `number` | #### Returns @@ -1464,9 +1464,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L189) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L189) ---- +___ ### track @@ -1474,11 +1474,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :----------- | :------------------------------------------------------ | -| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `_from` | [`NvmAccount`](NvmAccount.md) | -| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `_from` | [`NvmAccount`](NvmAccount.md) | +| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1490,9 +1490,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:118](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L118) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:118](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L118) ---- +___ ### validateAgreement @@ -1500,14 +1500,14 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `NFT721AccessTemplateParams` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `extra` | `any` | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreement_id` | `string` | +| `did` | `string` | +| `params` | `NFT721AccessTemplateParams` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `extra` | `any` | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1519,9 +1519,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L141) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L141) ---- +___ ### getInstance @@ -1529,8 +1529,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1543,9 +1543,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:33](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L33) +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:33](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L33) ---- +___ ### setInstanceConfig @@ -1553,15 +1553,15 @@ Prints the agreement status. #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1574,4 +1574,4 @@ Prints the agreement status. #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/NFT721Api.md b/docs/nevermined-sdk/api-reference/classes/NFT721Api.md index 75ed3c9acf..6d63ed4692 100644 --- a/docs/nevermined-sdk/api-reference/classes/NFT721Api.md +++ b/docs/nevermined-sdk/api-reference/classes/NFT721Api.md @@ -101,9 +101,9 @@ Allows the interaction with external ERC-721 NFT contracts built on top of the N #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:27](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L27) +[src/nevermined/api/nfts/NFT721Api.ts:27](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L27) ---- +___ ### servicePlugin @@ -119,7 +119,7 @@ Allows the interaction with external ERC-721 NFT contracts built on top of the N #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L39) +[src/nevermined/api/RegistryBaseApi.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L39) ## Accessors @@ -137,9 +137,9 @@ The NFT contract address #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:60](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L60) +[src/nevermined/api/nfts/NFT721Api.ts:60](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L60) ---- +___ ### artifactsFolder @@ -155,9 +155,9 @@ NFTsBaseApi.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -173,9 +173,9 @@ NFTsBaseApi.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -191,9 +191,9 @@ NFTsBaseApi.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -209,9 +209,9 @@ NFTsBaseApi.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### getContract @@ -227,9 +227,9 @@ The `Nft721Contract` instance #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:68](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L68) +[src/nevermined/api/nfts/NFT721Api.ts:68](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L68) ---- +___ ### instanceConfig @@ -245,9 +245,9 @@ NFTsBaseApi.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -263,9 +263,9 @@ NFTsBaseApi.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -281,9 +281,9 @@ NFTsBaseApi.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -299,9 +299,9 @@ NFTsBaseApi.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -311,69 +311,69 @@ NFTsBaseApi.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -381,9 +381,9 @@ NFTsBaseApi.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -393,38 +393,38 @@ NFTsBaseApi.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -432,26 +432,26 @@ NFTsBaseApi.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods ### \_details -▸ **\_details**(`did`, `ercType`): `Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> +▸ **_details**(`did`, `ercType`): `Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> Get the details of an NFT #### Parameters -| Name | Type | Description | -| :-------- | :------------------------------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `ercType` | [`ERCType`](../enums/ERCType.md) | The type of NFT used | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `ercType` | [`ERCType`](../enums/ERCType.md) | The type of NFT used | #### Returns -`Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> +`Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> The details of the NFT. @@ -471,13 +471,13 @@ assert.equal(details.owner, artist.getId()) #### Inherited from -[NFTsBaseApi](NFTsBaseApi.md).[\_details](NFTsBaseApi.md#_details) +[NFTsBaseApi](NFTsBaseApi.md).[_details](NFTsBaseApi.md#_details) #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:152](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L152) +[src/nevermined/api/nfts/NFTsBaseApi.ts:152](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L152) ---- +___ ### access @@ -487,16 +487,16 @@ Access the files associated with an NFT. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------------------------------ | -| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The user account holding NFTs (after purchase) requesting the access | -| `destination?` | `string` | `undefined` | The download destination for the files. | -| `fileIndex?` | `number` | `undefined` | The index of the file. If unset will download all the files in the asset. | -| `agreementId` | `string` | `'0x'` | The NFT sales agreement id. | -| `buyer?` | `string` | `undefined` | Key which represent the buyer | -| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | - | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service reference to use. By default is nft-access. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The user account holding NFTs (after purchase) requesting the access | +| `destination?` | `string` | `undefined` | The download destination for the files. | +| `fileIndex?` | `number` | `undefined` | The index of the file. If unset will download all the files in the asset. | +| `agreementId` | `string` | `'0x'` | The NFT sales agreement id. | +| `buyer?` | `string` | `undefined` | Key which represent the buyer | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | - | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service reference to use. By default is nft-access. | #### Returns @@ -521,9 +521,9 @@ const result = await nevermined.nfts1155.access(ddo.id, collector, '/tmp/') #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:427](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L427) +[src/nevermined/api/nfts/NFTsBaseApi.ts:427](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L427) ---- +___ ### addRating @@ -533,14 +533,14 @@ Given a DID, it adds a vote to the asset curation information. #### Parameters -| Name | Type | Default value | Description | -| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `newRating` | `number` | `undefined` | New average rating of the asset | -| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `newRating` | `number` | `undefined` | New average rating of the asset | +| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -554,9 +554,9 @@ Given a DID, it adds a vote to the asset curation information. #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:534](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L534) +[src/nevermined/api/RegistryBaseApi.ts:534](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L534) ---- +___ ### balanceOf @@ -566,8 +566,8 @@ Get the NFT balance for a particular account/address #### Parameters -| Name | Type | Description | -| :-------- | :---------------------------------------- | :------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `account` | `string` \| [`NvmAccount`](NvmAccount.md) | The account/address to check the balance of. | #### Returns @@ -584,9 +584,9 @@ const balance = await nevermined.nfts721.balance(artist) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:506](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L506) +[src/nevermined/api/nfts/NFT721Api.ts:506](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L506) ---- +___ ### burn @@ -596,11 +596,11 @@ Burn NFTs associated with an asset. #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :--------------------------------------- | -| `tokenId` | `string` | The identifier of the token to burn | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the publisher of the NFT. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `tokenId` | `string` | The identifier of the token to burn | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the publisher of the NFT. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -615,14 +615,17 @@ The publisher can only burn NFTs that it owns. NFTs that were already transferre **`Example`** ```ts -await nevermined.nfts721.burn(tokenId, artist) +await nevermined.nfts721.burn( + tokenId, + artist +) ``` #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:348](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L348) +[src/nevermined/api/nfts/NFT721Api.ts:348](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L348) ---- +___ ### buySecondaryMarketNft @@ -632,13 +635,13 @@ Buys a number of listed NFTs on secondary markets. #### Parameters -| Name | Type | Description | -| :------------------ | :---------------------------------------------- | :--------------------------------------------------------- | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the buyer/consumer. | -| `nftAmount` | `bigint` | The number of assets to buy. 1 by default. | -| `agreementIdSeed` | `string` | The seed of the initial sales agreement created off-chain. | -| `conditionsTimeout` | `number`[] | The timeout for the conditions. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the buyer/consumer. | +| `nftAmount` | `bigint` | The number of assets to buy. 1 by default. | +| `agreementIdSeed` | `string` | The seed of the initial sales agreement created off-chain. | +| `conditionsTimeout` | `number`[] | The timeout for the conditions. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -649,7 +652,11 @@ true if the buy was successful. **`Example`** ```ts -const result = await nevermined.nfts1155.buySecondaryMarketNft(collector, 1n, agreementId) +const result = await nevermined.nfts1155.buySecondaryMarketNft( + collector, + 1n, + agreementId + ) ``` **`Throws`** @@ -663,9 +670,9 @@ Thrown if there is an error buying the NFT. #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:345](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L345) +[src/nevermined/api/nfts/NFTsBaseApi.ts:345](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L345) ---- +___ ### claim @@ -675,13 +682,13 @@ Claims the transfer of a NFT to the Nevermined Node on behalf of the publisher. #### Parameters -| Name | Type | Description | -| :-------------- | :------- | :------------------------------------------------------- | -| `agreementId` | `string` | The NFT sales agreement id. | -| `nftHolder` | `string` | The address of the current owner of the NFT. | -| `nftReceiver` | `string` | The address where the NFT should be transferred. | -| `did?` | `string` | The Decentralized Identifier of the asset. | -| `serviceIndex?` | `any` | The index of the service in the DDO that will be claimed | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | The NFT sales agreement id. | +| `nftHolder` | `string` | The address of the current owner of the NFT. | +| `nftReceiver` | `string` | The address where the NFT should be transferred. | +| `did?` | `string` | The Decentralized Identifier of the asset. | +| `serviceIndex?` | `any` | The index of the service in the DDO that will be claimed | #### Returns @@ -701,14 +708,18 @@ as soon as the payment is made **`Example`** ```ts -const receipt = await nevermined.nfts721.claim(agreementId, editor.getId(), subscriber.getId()) +const receipt = await nevermined.nfts721.claim( + agreementId, + editor.getId(), + subscriber.getId() + ) ``` #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:198](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L198) +[src/nevermined/api/nfts/NFT721Api.ts:198](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L198) ---- +___ ### claimNFT @@ -718,15 +729,15 @@ Claims the transfer of a NFT to the Nevermined Node on behalf of the publisher. #### Parameters -| Name | Type | Default value | Description | -| :--------------- | :------------------------------- | :------------ | :--------------------------------------------------------------------------- | -| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | -| `nftHolder` | `string` | `undefined` | The address of the current owner of the NFT. | -| `nftReceiver` | `string` | `undefined` | The address where the NFT should be transferred. | -| `numberEditions` | `bigint` | `undefined` | The number of NFT editions to transfer. If the NFT is ERC-721 it should be 1 | -| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The Type of the NFT ERC (1155 or 721). | -| `did?` | `string` | `undefined` | The DID of the asset. | -| `serviceIndex?` | `number` | `undefined` | The index of the service in the DDO that will be claimed | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `nftHolder` | `string` | `undefined` | The address of the current owner of the NFT. | +| `nftReceiver` | `string` | `undefined` | The address where the NFT should be transferred. | +| `numberEditions` | `bigint` | `undefined` | The number of NFT editions to transfer. If the NFT is ERC-721 it should be 1 | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The Type of the NFT ERC (1155 or 721). | +| `did?` | `string` | `undefined` | The DID of the asset. | +| `serviceIndex?` | `number` | `undefined` | The index of the service in the DDO that will be claimed | #### Returns @@ -747,12 +758,12 @@ as soon as the payment is made ```ts const receipt = await nevermined.nfts721.claim( - agreementId, - editor.getId(), - subscriber.getId(), - nftAmount, - 721, -) + agreementId, + editor.getId(), + subscriber.getId(), + nftAmount, + 721 + ) ``` **`Throws`** @@ -765,9 +776,9 @@ const receipt = await nevermined.nfts721.claim( #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L52) +[src/nevermined/api/nfts/NFTsBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L52) ---- +___ ### create @@ -777,12 +788,12 @@ Creates a new Nevermined asset associated to a NFT (ERC-721). #### Parameters -| Name | Type | Description | -| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | -| `nftAttributes` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | +| Name | Type | Description | +| :------ | :------ | :------ | +| `nftAttributes` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | | `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -817,25 +828,25 @@ ddo = await nevermined.nfts721.create( #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:102](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L102) +[src/nevermined/api/nfts/NFT721Api.ts:102](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L102) ---- +___ ### details -▸ **details**(`did`): `Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> +▸ **details**(`did`): `Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> Get the details of an NFT #### Parameters -| Name | Type | Description | -| :---- | :------- | :--------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `did` | `string` | The Decentralized Identifier of the NFT asset. | #### Returns -`Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> +`Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> The details of the NFT. @@ -855,9 +866,9 @@ assert.equal(details.owner, artist.getId()) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:638](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L638) +[src/nevermined/api/nfts/NFT721Api.ts:638](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L638) ---- +___ ### getSubscriptionToken @@ -867,10 +878,10 @@ Get a JWT token for an asset associated with a webService #### Parameters -| Name | Type | Description | -| :----- | :---------------------------- | :----------------------------------------------------------------------------- | -| `did` | `string` | The did of the asset with a webService resource and an associated subscription | -| `from` | [`NvmAccount`](NvmAccount.md) | Account of the user requesting the token | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The did of the asset with a webService resource and an associated subscription | +| `from` | [`NvmAccount`](NvmAccount.md) | Account of the user requesting the token | #### Returns @@ -893,9 +904,9 @@ assert.isDefined(response.neverminedProxyUri) #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:490](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L490) +[src/nevermined/api/nfts/NFTsBaseApi.ts:490](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L490) ---- +___ ### grantOperatorRole @@ -906,11 +917,11 @@ Granting and revoking operator permissions only can be done by the NFT Contract #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :--------------------------------------------------------------------- | -| `operatorAddress` | `string` | The address of the account to be added as operator in the NFT Contract | -| `from` | [`NvmAccount`](NvmAccount.md) | The account giving operator permissions | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | The address of the account to be added as operator in the NFT Contract | +| `from` | [`NvmAccount`](NvmAccount.md) | The account giving operator permissions | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -921,14 +932,17 @@ The TransactionReceipt **`Example`** ```ts -await nevermined.nfts721.grantOperatorRole(someoneElse, artist) +await nevermined.nfts721.grantOperatorRole( + someoneElse, + artist +) ``` #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:584](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L584) +[src/nevermined/api/nfts/NFT721Api.ts:584](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L584) ---- +___ ### isApprovedForAll @@ -938,10 +952,10 @@ Returns if the `operatorAddress` is approved #### Parameters -| Name | Type | Description | -| :---------------- | :------- | :--------------------------------------------------------------------------------------- | -| `operatorAddress` | `string` | The address to check the permissions | -| `from` | `string` | The address of the account granting or revoking the permissions via `setApprovalForAll`. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | The address to check the permissions | +| `from` | `string` | The address of the account granting or revoking the permissions via `setApprovalForAll`. | #### Returns @@ -957,9 +971,9 @@ await nevermined.nfts721.isApprovedForAll(someoneElse, artist.getId()) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:490](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L490) +[src/nevermined/api/nfts/NFT721Api.ts:490](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L490) ---- +___ ### isOperator @@ -969,11 +983,11 @@ Check if a particular address is the operator of given a NFT address. #### Parameters -| Name | Type | Default value | Description | -| :------------------- | :------------------------------- | :------------ | :-------------------------------------- | -| `nftContractAddress` | `string` | `undefined` | The DID of the NFT to check | -| `operatorAddress` | `string` | `undefined` | The address to check if operator status | -| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `nftContractAddress` | `string` | `undefined` | The DID of the NFT to check | +| `operatorAddress` | `string` | `undefined` | The address to check if operator status | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | #### Returns @@ -987,9 +1001,9 @@ operator status of address as a boolean #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:118](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L118) +[src/nevermined/api/nfts/NFTsBaseApi.ts:118](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L118) ---- +___ ### isOperatorOfDID @@ -999,10 +1013,10 @@ It checks if an address is an operator of the NFT associated to the asset #### Parameters -| Name | Type | Description | -| :-------- | :------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized identifier of the NFT asset. | -| `address` | `string` | The address to check if operator status | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The Decentralized identifier of the NFT asset. | +| `address` | `string` | The address to check if operator status | #### Returns @@ -1016,9 +1030,9 @@ true if the address is an operator of the NFT #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:648](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L648) +[src/nevermined/api/nfts/NFT721Api.ts:648](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L648) ---- +___ ### list @@ -1029,13 +1043,13 @@ In a Nevermined environment, when an asset is unlisted, it is not possible to be #### Parameters -| Name | Type | Default value | Description | -| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -1049,9 +1063,9 @@ In a Nevermined environment, when an asset is unlisted, it is not possible to be #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:482](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L482) +[src/nevermined/api/RegistryBaseApi.ts:482](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L482) ---- +___ ### listOnSecondaryMarkets @@ -1061,15 +1075,15 @@ After purchase re-list an NFT to enable secondary market sales. #### Parameters -| Name | Type | Description | -| :------------ | :---------------------------- | :----------------------------------------------------------- | -| `ddo` | [`DDO`](DDO.md) | The DDO of the asset. | -| `assetPrice` | [`AssetPrice`](AssetPrice.md) | The current setup of asset rewards. | -| `nftAmount` | `bigint` | The number of NFTs put up for secondary sale. | -| `nftTransfer` | `boolean` | - | -| `provider` | `string` | The address that will be the provider of the secondary sale. | -| `token` | [`Token`](Token.md) | - | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the current owner. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | The DDO of the asset. | +| `assetPrice` | [`AssetPrice`](AssetPrice.md) | The current setup of asset rewards. | +| `nftAmount` | `bigint` | The number of NFTs put up for secondary sale. | +| `nftTransfer` | `boolean` | - | +| `provider` | `string` | The address that will be the provider of the secondary sale. | +| `token` | [`Token`](Token.md) | - | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the current owner. | #### Returns @@ -1081,13 +1095,13 @@ the agreementId of the secondary sale. ```ts const agreementId = await nevermined.nfts1155.listOnSecondaryMarkets( - ddo, - assetPrice, - numberNFTs, - collector.getId(), - token, - collector.getId(), -) + ddo, + assetPrice, + numberNFTs, + collector.getId(), + token, + collector.getId() + ) ``` **`Throws`** @@ -1101,9 +1115,9 @@ Thrown if there is an error listing the NFT. #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:262](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L262) +[src/nevermined/api/nfts/NFTsBaseApi.ts:262](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L262) ---- +___ ### mint @@ -1115,11 +1129,11 @@ This function can be called multiple times as long as the minting does not excee #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the minter | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the minter | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -1135,9 +1149,9 @@ await nevermined.nfts721.mint(ddo.id, artist) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:324](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L324) +[src/nevermined/api/nfts/NFT721Api.ts:324](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L324) ---- +___ ### mintWithURL @@ -1149,13 +1163,13 @@ This function can be called multiple times as long as the minting does not excee #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :--------------------------------------------- | -| `to` | `string` | The address receiving the NFT minted | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `url` | `string` | The URL with NFT metadata | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the minter | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `to` | `string` | The address receiving the NFT minted | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `url` | `string` | The URL with NFT metadata | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the minter | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -1171,9 +1185,9 @@ await nevermined.nfts721.mintWithURL(receiverAddress, ddo.id, nftMetadata, artis #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:368](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L368) +[src/nevermined/api/nfts/NFT721Api.ts:368](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L368) ---- +___ ### order @@ -1183,12 +1197,12 @@ Order a NFT-721. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------ | :------------------------------------------------------------- | -| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account of the NFT buyer. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account of the NFT buyer. | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to order | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | #### Returns @@ -1209,9 +1223,9 @@ const agreementId = await nevermined.nfts721.order(ddo.id, collector) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:139](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L139) +[src/nevermined/api/nfts/NFT721Api.ts:139](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L139) ---- +___ ### orderAsset @@ -1222,12 +1236,12 @@ then sends the request to the publisher via the service endpoint (Node http serv #### Parameters -| Name | Type | Description | -| :----------------- | :------------------------------------------------------------ | :--------------------- | -| `did` | `string` | Decentralized ID. | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | -| `from` | [`NvmAccount`](NvmAccount.md) | Consumer account. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | Decentralized ID. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `from` | [`NvmAccount`](NvmAccount.md) | Consumer account. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -1241,9 +1255,9 @@ The agreement ID. #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:585](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L585) +[src/nevermined/api/RegistryBaseApi.ts:585](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L585) ---- +___ ### ownerOf @@ -1253,8 +1267,8 @@ Gets the contract owner #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -1266,14 +1280,16 @@ Address of the contract owner **`Example`** ```ts -const nftContractOwner = new NvmAccount(await nevermined.nfts721.ownerOf()) +const nftContractOwner = new NvmAccount( + await nevermined.nfts721.ownerOf() +) ``` #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:417](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L417) +[src/nevermined/api/nfts/NFT721Api.ts:417](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L417) ---- +___ ### ownerOfAsset @@ -1283,8 +1299,8 @@ Given a DID it gets the owner of the NFT if that DID is used as tokenId #### Parameters -| Name | Type | Description | -| :---- | :------- | :--------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `did` | `string` | The Decentralized identifier of the NFT asset. | #### Returns @@ -1301,9 +1317,9 @@ const owner = await nevermined.nfts721.ownerOfAsset(ddo.id, nftTokenAddress) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:451](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L451) +[src/nevermined/api/nfts/NFT721Api.ts:451](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L451) ---- +___ ### ownerOfAssetByAgreement @@ -1313,10 +1329,10 @@ Given a DID and an agreement id it gets the owner of the NFT #### Parameters -| Name | Type | Description | -| :------------ | :------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized identifier of the NFT asset. | -| `agreementId` | `string` | The NFT sales agreement id. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The Decentralized identifier of the NFT asset. | +| `agreementId` | `string` | The NFT sales agreement id. | #### Returns @@ -1332,9 +1348,9 @@ const owner = await nevermined.nfts721.ownerOfAssetByAgreement(ddo.id, agreement #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:468](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L468) +[src/nevermined/api/nfts/NFT721Api.ts:468](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L468) ---- +___ ### ownerOfTokenId @@ -1344,8 +1360,8 @@ Given some information, it gets the public address of the asset owner #### Parameters -| Name | Type | Description | -| :-------- | :------- | :----------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `tokenId` | `string` | The token id | #### Returns @@ -1362,9 +1378,9 @@ const owner = await nevermined.nfts721.ownerOfTokenId(tokenId) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:434](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L434) +[src/nevermined/api/nfts/NFT721Api.ts:434](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L434) ---- +___ ### registerNeverminedAsset @@ -1375,13 +1391,13 @@ via the Nevermined APIs directly. It must accessed via the `assets`, `compute`, #### Parameters -| Name | Type | Description | -| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | -| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | +| Name | Type | Description | +| :------ | :------ | :------ | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | | `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -1399,9 +1415,9 @@ The metadata of the asset created (DDO) #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L52) +[src/nevermined/api/RegistryBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L52) ---- +___ ### releaseRewards @@ -1411,13 +1427,13 @@ Release the funds from escrow. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------ | :----------------------------------------------------------------------- | -| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | -| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The current owner of the NFTs. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The current owner of the NFTs. | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to release rewards | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | #### Returns @@ -1432,7 +1448,11 @@ A publisher is able to release the funds put on escrow by the consumer after tra **`Example`** ```ts -const receipt = await nevermined.nfts721.releaseRewards(agreementId, ddo.id, artist) +const receipt = await nevermined.nfts721.releaseRewards( + agreementId, + ddo.id, + artist + ) ``` **`Throws`** @@ -1442,9 +1462,9 @@ Thrown if there is an error releasing the rewards. #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:283](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L283) +[src/nevermined/api/nfts/NFT721Api.ts:283](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L283) ---- +___ ### releaseSecondaryMarketRewards @@ -1454,12 +1474,12 @@ Used to release the secondary market NFT & the locked rewards. #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :---------------------------------------------------------------- | -| `owner` | [`NvmAccount`](NvmAccount.md) | The owner account. | -| `account` | [`NvmAccount`](NvmAccount.md) | Account of the user sending the transaction | -| `agreementIdSeed` | `string` | the seed of the Agreement Id of the underlying service agreement. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `owner` | [`NvmAccount`](NvmAccount.md) | The owner account. | +| `account` | [`NvmAccount`](NvmAccount.md) | Account of the user sending the transaction | +| `agreementIdSeed` | `string` | the seed of the Agreement Id of the underlying service agreement. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -1480,9 +1500,9 @@ Thrown if there is an error releasing the rewards. #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:529](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L529) +[src/nevermined/api/nfts/NFT721Api.ts:529](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L529) ---- +___ ### resolveAsset @@ -1493,9 +1513,9 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Parameters -| Name | Type | Default value | Description | -| :------- | :------------------------------------------------- | :---------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID. | | `policy` | [`DIDResolvePolicy`](../enums/DIDResolvePolicy.md) | `DIDResolvePolicy.MetadataAPIFirst` | It specifies the resolve policy to apply. It allows to select that priorities during the asset resolution via Metadata API or Immutable URLs (IPFS, Filecoin, etc) | #### Returns @@ -1510,9 +1530,9 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:324](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L324) +[src/nevermined/api/RegistryBaseApi.ts:324](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L324) ---- +___ ### revokeOperatorRole @@ -1523,11 +1543,11 @@ Granting and revoking minting permissions only can be done by the NFT Contract o #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :----------------------------------------------------------------------- | -| `operatorAddress` | `string` | The address of the account to be revoked as operator in the NFT Contract | -| `from` | [`NvmAccount`](NvmAccount.md) | The account revoking operator permissions | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | The address of the account to be revoked as operator in the NFT Contract | +| `from` | [`NvmAccount`](NvmAccount.md) | The account revoking operator permissions | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -1538,14 +1558,17 @@ The TransactionReceipt **`Example`** ```ts -await nevermined.nfts721.revokeOperatorRole(someoneElse, artist) +await nevermined.nfts721.revokeOperatorRole( + someoneElse, + artist +) ``` #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:610](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L610) +[src/nevermined/api/nfts/NFT721Api.ts:610](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L610) ---- +___ ### setApprovalForAll @@ -1555,12 +1578,12 @@ Enable or disable NFT permissions for an operator. #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :------------------------------------------------------------------- | -| `target` | `string` | The address that of the operator we want to give transfer rights to. | -| `approved` | `boolean` | Give or remove transfer rights from the operator. | -| `from` | [`NvmAccount`](NvmAccount.md) | The account that wants to give transfer rights to the operator. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `target` | `string` | The address that of the operator we want to give transfer rights to. | +| `approved` | `boolean` | Give or remove transfer rights from the operator. | +| `from` | [`NvmAccount`](NvmAccount.md) | The account that wants to give transfer rights to the operator. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -1571,14 +1594,18 @@ The TransactionReceipt **`Example`** ```ts -await nevermined.nfts721.setApprovalForAll(someoneElse, true, artist) +await nevermined.nfts721.setApprovalForAll( + someoneElse, + true, + artist +) ``` #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:396](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L396) +[src/nevermined/api/nfts/NFT721Api.ts:396](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L396) ---- +___ ### setInstanceConfig @@ -1586,8 +1613,8 @@ await nevermined.nfts721.setApprovalForAll(someoneElse, true, artist) #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1600,9 +1627,9 @@ await nevermined.nfts721.setApprovalForAll(someoneElse, true, artist) #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### transfer @@ -1613,13 +1640,13 @@ This method only will work if called by the owner of the asset or a provider. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------ | :---------------------------------------------------------------- | -| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | -| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The current owner of the NFTs. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The current owner of the NFTs. | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to transfer | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | #### Returns @@ -1645,9 +1672,9 @@ Thrown if there is an error transferring the NFT #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:232](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L232) +[src/nevermined/api/nfts/NFT721Api.ts:232](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L232) ---- +___ ### updateAsset @@ -1657,13 +1684,13 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Parameters -| Name | Type | Default value | Description | -| :----------------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -1677,9 +1704,9 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:367](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L367) +[src/nevermined/api/RegistryBaseApi.ts:367](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L367) ---- +___ ### getInstance @@ -1689,10 +1716,10 @@ Create a new Nevermined NFTs (ERC-721) instance allowing to interact with that k #### Parameters -| Name | Type | Description | -| :------------------- | :---------------------------------------------------------- | :-------------------------------------------------------------------------------- | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | The Nevermined config | -| `nftContractAddress` | `string` | If the Nft721 Contract is deployed in an address it will connect to that contract | +| Name | Type | Description | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | The Nevermined config | +| `nftContractAddress` | `string` | If the Nft721 Contract is deployed in an address it will connect to that contract | #### Returns @@ -1703,7 +1730,10 @@ The NFTs 721 API instance [NFT721Api](NFT721Api.md). **`Example`** ```ts -nfts721 = await Nft721Api.getInstance(instanceConfig, nftContractAddress) +nfts721 = await Nft721Api.getInstance( + instanceConfig, + nftContractAddress +) ``` #### Overrides @@ -1712,9 +1742,9 @@ nfts721 = await Nft721Api.getInstance(instanceConfig, nftContractAddress) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L44) +[src/nevermined/api/nfts/NFT721Api.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L44) ---- +___ ### getNFTContractAddress @@ -1724,9 +1754,9 @@ Gets the NFT contract address associated with a Nevermined asset from the DDO. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------ | -| `ddo` | [`DDO`](DDO.md) | `undefined` | The DDO of the asset. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | `undefined` | The DDO of the asset. | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service type to look for the contract address | #### Returns @@ -1747,9 +1777,9 @@ const nftContractAddress = NFT1155Api.getNFTContractAddress(ddo) #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:221](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L221) +[src/nevermined/api/nfts/NFTsBaseApi.ts:221](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L221) ---- +___ ### getServicePlugin @@ -1759,8 +1789,8 @@ Initializes the default Nevermined service plugins and return that instance #### Parameters -| Name | Type | Description | -| :------- | :---------------------------------------------------------- | :---------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Nevermined config | #### Returns @@ -1769,12 +1799,12 @@ Initializes the default Nevermined service plugins and return that instance The Nevermined Service Plugin instance -| Name | Type | -| :----------- | :-------------------------------------------------------------------- | -| `access` | [`AccessService`](AccessService.md) | -| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | -| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | -| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | +| Name | Type | +| :------ | :------ | +| `access` | [`AccessService`](AccessService.md) | +| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | +| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | +| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | #### Inherited from @@ -1782,9 +1812,9 @@ The Nevermined Service Plugin instance #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:640](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L640) +[src/nevermined/api/RegistryBaseApi.ts:640](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L640) ---- +___ ### setInstanceConfig @@ -1792,15 +1822,15 @@ The Nevermined Service Plugin instance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1813,4 +1843,4 @@ The Nevermined Service Plugin instance #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/NFT721HolderCondition.md b/docs/nevermined-sdk/api-reference/classes/NFT721HolderCondition.md index 2b291bbc27..33abf9496d 100644 --- a/docs/nevermined-sdk/api-reference/classes/NFT721HolderCondition.md +++ b/docs/nevermined-sdk/api-reference/classes/NFT721HolderCondition.md @@ -74,8 +74,8 @@ Allows to fulfill a condition to users holding some amount of NFTs for a specifi #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -88,7 +88,7 @@ ConsumerCondition\.constructor #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -102,9 +102,9 @@ ConsumerCondition.address #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -116,9 +116,9 @@ ConsumerCondition.contract #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -130,9 +130,9 @@ ConsumerCondition.contractName #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -144,9 +144,9 @@ ConsumerCondition.events #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -158,7 +158,7 @@ ConsumerCondition.version #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -176,9 +176,9 @@ ConsumerCondition.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -194,9 +194,9 @@ ConsumerCondition.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -212,9 +212,9 @@ ConsumerCondition.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -230,9 +230,9 @@ ConsumerCondition.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -248,9 +248,9 @@ ConsumerCondition.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -266,9 +266,9 @@ ConsumerCondition.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -284,9 +284,9 @@ ConsumerCondition.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -302,9 +302,9 @@ ConsumerCondition.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -314,69 +314,69 @@ ConsumerCondition.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -384,9 +384,9 @@ ConsumerCondition.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -396,38 +396,38 @@ ConsumerCondition.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -435,7 +435,7 @@ ConsumerCondition.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -445,11 +445,11 @@ ConsumerCondition.walletClient #### Parameters -| Name | Type | -| :------------ | :---------------------------------------------- | -| `conditionId` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `conditionId` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -461,9 +461,9 @@ ConsumerCondition.abortByTimeOut #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L75) +[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L75) ---- +___ ### call @@ -472,16 +472,16 @@ ConsumerCondition.abortByTimeOut #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -493,9 +493,9 @@ ConsumerCondition.call #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### fulfill @@ -505,14 +505,14 @@ Fulfill requires a validation that holder as enough NFTs for a specific DID. #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :----------------------------------------------- | -| `agreementId` | `string` | SEA agreement identifier. | -| `did` | `string` | The Decentralized Identifier of the asset. | -| `holderAddress` | `string` | The contract address where the reward is locked. | -| `nftTokenAddress` | `string` | The contract address of the nft to use. | -| `from` | [`NvmAccount`](NvmAccount.md) | Account sending the transaction | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transacion parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | SEA agreement identifier. | +| `did` | `string` | The Decentralized Identifier of the asset. | +| `holderAddress` | `string` | The contract address where the reward is locked. | +| `nftTokenAddress` | `string` | The contract address of the nft to use. | +| `from` | [`NvmAccount`](NvmAccount.md) | Account sending the transaction | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transacion parameters | #### Returns @@ -526,9 +526,9 @@ ConsumerCondition.fulfill #### Defined in -[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L57) +[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L57) ---- +___ ### fulfillInstance @@ -536,13 +536,13 @@ ConsumerCondition.fulfill #### Parameters -| Name | Type | Default value | -| :----------------- | :-------------------------------------------------------- | :------------ | -| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -554,9 +554,9 @@ ConsumerCondition.fulfillInstance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L139) +[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L139) ---- +___ ### fulfillPlain @@ -564,13 +564,13 @@ ConsumerCondition.fulfillInstance #### Parameters -| Name | Type | Default value | -| :------------ | :-------------------------------------------------------- | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -582,9 +582,9 @@ ConsumerCondition.fulfillPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L47) +[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L47) ---- +___ ### fulfillWithNode @@ -592,12 +592,12 @@ ConsumerCondition.fulfillPlain #### Parameters -| Name | Type | -| :------------------ | :----------------------------------------------------- | -| `_cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | -| `_additionalParams` | `Record`\<`string`, `unknown`\> | -| `_from` | [`NvmAccount`](NvmAccount.md) | -| `_txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `_cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | +| `_additionalParams` | `Record`\<`string`, `unknown`\> | +| `_from` | [`NvmAccount`](NvmAccount.md) | +| `_txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -609,9 +609,9 @@ ConsumerCondition.fulfillWithNode #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:209](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L209) +[src/keeper/contracts/conditions/Condition.abstract.ts:209](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L209) ---- +___ ### generateId @@ -619,10 +619,10 @@ ConsumerCondition.fulfillWithNode #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -634,9 +634,9 @@ ConsumerCondition.generateId #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L61) +[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L61) ---- +___ ### generateIdHash @@ -644,10 +644,10 @@ ConsumerCondition.generateId #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `...values` | `any`[] | +| `...values` | `any`[] | #### Returns @@ -659,9 +659,9 @@ ConsumerCondition.generateIdHash #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L57) +[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L57) ---- +___ ### generateIdWithSeed @@ -669,10 +669,10 @@ ConsumerCondition.generateIdHash #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -684,9 +684,9 @@ ConsumerCondition.generateIdWithSeed #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L65) +[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L65) ---- +___ ### getConditionFulfilledEvent @@ -694,8 +694,8 @@ ConsumerCondition.generateIdWithSeed #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns @@ -708,9 +708,9 @@ ConsumerCondition.getConditionFulfilledEvent #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L79) +[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L79) ---- +___ ### getFromAddress @@ -718,8 +718,8 @@ ConsumerCondition.getConditionFulfilledEvent #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -732,24 +732,24 @@ ConsumerCondition.getFromAddress #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -757,9 +757,9 @@ ConsumerCondition.getTransactionLogs #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### hashValues @@ -767,8 +767,8 @@ ConsumerCondition.getTransactionLogs #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -781,9 +781,9 @@ ConsumerCondition.hashValues #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L116) +[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L116) ---- +___ ### hashValuesPlain @@ -791,8 +791,8 @@ ConsumerCondition.hashValues #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -805,9 +805,9 @@ ConsumerCondition.hashValuesPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L122) +[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L122) ---- +___ ### init @@ -815,11 +815,11 @@ ConsumerCondition.hashValuesPlain #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -831,9 +831,9 @@ ConsumerCondition.init #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instance @@ -841,10 +841,10 @@ ConsumerCondition.init #### Parameters -| Name | Type | -| :------------ | :------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | #### Returns @@ -856,9 +856,9 @@ ConsumerCondition.instance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L163) +[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L163) ---- +___ ### instanceFromDDO @@ -866,11 +866,11 @@ ConsumerCondition.instance #### Parameters -| Name | Type | -| :------------ | :-------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `NFT721HolderConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `ctx` | `NFT721HolderConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | #### Returns @@ -882,9 +882,9 @@ ConsumerCondition.instanceFromDDO #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L131) +[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L131) ---- +___ ### nftContractFromService @@ -892,8 +892,8 @@ ConsumerCondition.instanceFromDDO #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | #### Returns @@ -902,9 +902,9 @@ ConsumerCondition.instanceFromDDO #### Defined in -[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:37](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L37) +[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:37](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L37) ---- +___ ### params @@ -914,11 +914,11 @@ Generate the hash of condition inputs with the following parameters. #### Parameters -| Name | Type | Description | -| :---------------- | :------- | :----------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the asset. | -| `holderAddress` | `string` | The address of the NFT holder . | -| `nftTokenAddress` | `string` | The address of the nft 721 token to use | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The Decentralized Identifier of the asset. | +| `holderAddress` | `string` | The address of the NFT holder . | +| `nftTokenAddress` | `string` | The address of the nft 721 token to use | #### Returns @@ -932,9 +932,9 @@ ConsumerCondition.params #### Defined in -[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:33](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L33) +[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:33](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L33) ---- +___ ### paramsFromDDO @@ -942,8 +942,8 @@ ConsumerCondition.params #### Parameters -| Name | Type | -| :--------------- | :----------------------------- | +| Name | Type | +| :------ | :------ | | `«destructured»` | `NFT721HolderConditionContext` | #### Returns @@ -956,9 +956,9 @@ ConsumerCondition.paramsFromDDO #### Defined in -[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:43](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L43) +[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:43](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L43) ---- +___ ### send @@ -966,12 +966,12 @@ ConsumerCondition.paramsFromDDO #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -983,9 +983,9 @@ ConsumerCondition.send #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -993,12 +993,12 @@ ConsumerCondition.send #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1010,9 +1010,9 @@ ConsumerCondition.sendFrom #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -1020,8 +1020,8 @@ ConsumerCondition.sendFrom #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1034,9 +1034,9 @@ ConsumerCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1044,8 +1044,8 @@ ConsumerCondition.setInstanceConfig #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1058,9 +1058,9 @@ ConsumerCondition.someLog #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -1068,8 +1068,8 @@ ConsumerCondition.someLog #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1082,9 +1082,9 @@ ConsumerCondition.getInstance #### Defined in -[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L21) +[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L21) ---- +___ ### setInstanceConfig @@ -1092,15 +1092,15 @@ ConsumerCondition.getInstance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1113,4 +1113,4 @@ ConsumerCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/NFT721SalesTemplate.md b/docs/nevermined-sdk/api-reference/classes/NFT721SalesTemplate.md index f9e7eca45b..a6612086c9 100644 --- a/docs/nevermined-sdk/api-reference/classes/NFT721SalesTemplate.md +++ b/docs/nevermined-sdk/api-reference/classes/NFT721SalesTemplate.md @@ -91,8 +91,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -105,7 +105,7 @@ #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) ## Properties @@ -119,9 +119,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -133,9 +133,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -147,9 +147,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -161,9 +161,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -175,7 +175,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -193,9 +193,9 @@ BaseTemplate.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -211,9 +211,9 @@ BaseTemplate.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -229,9 +229,9 @@ BaseTemplate.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -247,9 +247,9 @@ BaseTemplate.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -265,9 +265,9 @@ BaseTemplate.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -283,9 +283,9 @@ BaseTemplate.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -301,9 +301,9 @@ BaseTemplate.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -319,9 +319,9 @@ BaseTemplate.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -331,69 +331,69 @@ BaseTemplate.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -401,9 +401,9 @@ BaseTemplate.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -413,38 +413,38 @@ BaseTemplate.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -452,7 +452,7 @@ BaseTemplate.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -462,8 +462,8 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | #### Returns @@ -476,9 +476,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:114](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L114) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:114](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L114) ---- +___ ### agreementId @@ -486,10 +486,10 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `agreementIdSeed` | `string` | -| `creator` | `string` | +| `creator` | `string` | #### Returns @@ -501,9 +501,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L202) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L202) ---- +___ ### call @@ -512,16 +512,16 @@ BaseTemplate.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -533,9 +533,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### conditions @@ -551,9 +551,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:55](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L55) +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:55](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L55) ---- +___ ### createAgreement @@ -561,16 +561,16 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `extraArgs` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `extraArgs` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -582,9 +582,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L73) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L73) ---- +___ ### createAgreementAndPay @@ -592,21 +592,21 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :--------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `accessConsumer` | `string` | -| `condIdx` | `number` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `bigint`[] | -| `receivers` | `string`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `accessConsumer` | `string` | +| `condIdx` | `number` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -618,9 +618,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L98) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L98) ---- +___ ### createAgreementFromDDO @@ -630,14 +630,14 @@ Create a new agreement using the data of a DDO. #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :---------- | -| `agreementIdSeed` | `string` | - | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `parameters` | `NFT721SalesTemplateParams` | | -| `consumer` | [`NvmAccount`](NvmAccount.md) | - | -| `timeOuts?` | `number`[] | - | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementIdSeed` | `string` | - | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `parameters` | `NFT721SalesTemplateParams` | | +| `consumer` | [`NvmAccount`](NvmAccount.md) | - | +| `timeOuts?` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | #### Returns @@ -651,9 +651,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L211) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L211) ---- +___ ### createAgreementWithPaymentFromDDO @@ -661,16 +661,16 @@ true if the call was successful. #### Parameters -| Name | Type | -| :----------------- | :------------------------------------------------------------------------------------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | -| `parameters` | `NFT721SalesTemplateParams` | -| `consumer` | [`NvmAccount`](NvmAccount.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | -| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | +| Name | Type | +| :------ | :------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `NFT721SalesTemplateParams` | +| `consumer` | [`NvmAccount`](NvmAccount.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | #### Returns @@ -682,9 +682,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L240) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L240) ---- +___ ### createService @@ -692,13 +692,13 @@ true if the call was successful. #### Parameters -| Name | Type | -| :------------------ | :---------------------------------------------------------------------------- | -| `publisher` | [`NvmAccount`](NvmAccount.md) | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | -| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | -| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | +| Name | Type | +| :------ | :------ | +| `publisher` | [`NvmAccount`](NvmAccount.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | #### Returns @@ -710,9 +710,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L48) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L48) ---- +___ ### description @@ -728,9 +728,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:37](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L37) +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:37](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L37) ---- +___ ### extraGen @@ -738,8 +738,8 @@ true if the call was successful. #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | #### Returns @@ -752,9 +752,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) ---- +___ ### getAgreementCreatedEvent @@ -764,8 +764,8 @@ Generates and returns the agreement creation event. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns @@ -780,23 +780,23 @@ Agreement created event. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L450) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L450) ---- +___ ### getAgreementData -▸ **getAgreementData**(`agreementId`): `Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> +▸ **getAgreementData**(`agreementId`): `Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns -`Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> +`Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> #### Inherited from @@ -804,9 +804,9 @@ Agreement created event. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L29) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L29) ---- +___ ### getAgreementIdsFromDDO @@ -816,12 +816,12 @@ Get agreement conditions IDs. #### Parameters -| Name | Type | Description | -| :------------ | :-------------------------- | :------------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `NFT721SalesTemplateParams` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | Agreement ID. | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `creator` | `string` | - | +| `params` | `NFT721SalesTemplateParams` | - | #### Returns @@ -835,25 +835,25 @@ The condition IDs. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L169) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L169) ---- +___ ### getAgreementStatus -▸ **getAgreementStatus**(`agreementId`): `Promise`\<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> +▸ **getAgreementStatus**(`agreementId`): `Promise`\<``false`` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> Returns the status of the conditions. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns -`Promise`\<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> +`Promise`\<``false`` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> The conditions status. @@ -863,9 +863,9 @@ The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L331) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L331) ---- +___ ### getAgreementsForDID @@ -873,8 +873,8 @@ The conditions status. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -887,9 +887,9 @@ The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L476) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L476) ---- +___ ### getConditionTypes @@ -909,9 +909,9 @@ A list of condition addresses. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L137) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L137) ---- +___ ### getConditions @@ -931,9 +931,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L148) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L148) ---- +___ ### getFromAddress @@ -941,8 +941,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -955,9 +955,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getServiceAgreementTemplate @@ -973,9 +973,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:104](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L104) +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:104](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L104) ---- +___ ### getServiceAgreementTemplateConditionByRef @@ -983,8 +983,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `ref` | `string` | #### Returns @@ -997,9 +997,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L314) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L314) ---- +___ ### getServiceAgreementTemplateConditions @@ -1015,17 +1015,17 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L309) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L309) ---- +___ ### getServiceAgreementTemplateDependencies -▸ **getServiceAgreementTemplateDependencies**(): `Promise`\<\{ `[condition: string]`: `string`[]; }\> +▸ **getServiceAgreementTemplateDependencies**(): `Promise`\<\{ `[condition: string]`: `string`[]; }\> #### Returns -`Promise`\<\{ `[condition: string]`: `string`[]; }\> +`Promise`\<\{ `[condition: string]`: `string`[]; }\> #### Inherited from @@ -1033,24 +1033,24 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L321) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L321) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -1058,9 +1058,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -1068,11 +1068,11 @@ A list of condition contracts. #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -1084,9 +1084,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instanceFromDDO @@ -1094,13 +1094,13 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------------------ | :-------------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `NFT721SalesTemplateParams` | -| `serviceReference?` | `number` | +| Name | Type | +| :------ | :------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `parameters` | `NFT721SalesTemplateParams` | +| `serviceReference?` | `number` | #### Returns @@ -1112,9 +1112,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L61) +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L61) ---- +___ ### lockConditionIndex @@ -1130,9 +1130,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L51) +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L51) ---- +___ ### lockTokens @@ -1140,12 +1140,12 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `tokenAddress` | `any` | +| `amounts` | `any` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1157,9 +1157,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L382) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L382) ---- +___ ### name @@ -1175,9 +1175,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:34](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L34) +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:34](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L34) ---- +___ ### params @@ -1185,10 +1185,10 @@ A list of condition contracts. #### Parameters -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `consumerId` | `string` | `undefined` | -| `expiration` | `number` | `0` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `consumerId` | `string` | `undefined` | +| `expiration` | `number` | `0` | #### Returns @@ -1200,9 +1200,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:41](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L41) +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:41](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L41) ---- +___ ### paramsGen @@ -1212,8 +1212,8 @@ Specialize params #### Parameters -| Name | Type | Description | -| :--------------- | :------------------------------------------------------ | :----------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `«destructured»` | [`ValidationParams`](../interfaces/ValidationParams.md) | Generic parameters | #### Returns @@ -1226,9 +1226,9 @@ Specialize params #### Defined in -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L44) +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L44) ---- +___ ### paymentData @@ -1236,8 +1236,8 @@ Specialize params #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | #### Returns @@ -1250,9 +1250,9 @@ Specialize params #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L61) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L61) ---- +___ ### printAgreementStatus @@ -1262,8 +1262,8 @@ Prints the agreement status. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns @@ -1276,9 +1276,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L418) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L418) ---- +___ ### process @@ -1286,11 +1286,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :---------- | :------------------------------------------------------ | -| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1302,9 +1302,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:126](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L126) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:126](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L126) ---- +___ ### send @@ -1312,12 +1312,12 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1329,9 +1329,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -1339,12 +1339,12 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1356,9 +1356,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### service @@ -1374,9 +1374,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:27](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L27) +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:27](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L27) ---- +___ ### serviceEndpoint @@ -1392,9 +1392,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:30](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L30) +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:30](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L30) ---- +___ ### setInstanceConfig @@ -1402,8 +1402,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1416,9 +1416,9 @@ Prints the agreement status. #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1426,8 +1426,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1440,9 +1440,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### standardContext @@ -1450,11 +1450,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :-------------- | :-------------- | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `serviceIndex?` | `number` | +| Name | Type | +| :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `serviceIndex?` | `number` | #### Returns @@ -1466,9 +1466,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L189) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L189) ---- +___ ### track @@ -1476,11 +1476,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :----------- | :------------------------------------------------------ | -| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `_from` | [`NvmAccount`](NvmAccount.md) | -| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `_from` | [`NvmAccount`](NvmAccount.md) | +| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1492,9 +1492,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:118](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L118) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:118](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L118) ---- +___ ### validateAgreement @@ -1502,14 +1502,14 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `NFT721SalesTemplateParams` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `extra` | `any` | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreement_id` | `string` | +| `did` | `string` | +| `params` | `NFT721SalesTemplateParams` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `extra` | `any` | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1521,9 +1521,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L141) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L141) ---- +___ ### getInstance @@ -1531,8 +1531,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1545,9 +1545,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:23](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L23) +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:23](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L23) ---- +___ ### setInstanceConfig @@ -1555,15 +1555,15 @@ Prints the agreement status. #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1576,4 +1576,4 @@ Prints the agreement status. #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/NFTAccessCondition.md b/docs/nevermined-sdk/api-reference/classes/NFTAccessCondition.md index a29470be58..9f95426763 100644 --- a/docs/nevermined-sdk/api-reference/classes/NFTAccessCondition.md +++ b/docs/nevermined-sdk/api-reference/classes/NFTAccessCondition.md @@ -73,8 +73,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -87,7 +87,7 @@ ProviderCondition\.constructor #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -101,9 +101,9 @@ ProviderCondition.address #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -115,9 +115,9 @@ ProviderCondition.contract #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -129,9 +129,9 @@ ProviderCondition.contractName #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -143,9 +143,9 @@ ProviderCondition.events #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -157,7 +157,7 @@ ProviderCondition.version #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -175,9 +175,9 @@ ProviderCondition.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -193,9 +193,9 @@ ProviderCondition.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -211,9 +211,9 @@ ProviderCondition.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -229,9 +229,9 @@ ProviderCondition.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -247,9 +247,9 @@ ProviderCondition.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -265,9 +265,9 @@ ProviderCondition.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -283,9 +283,9 @@ ProviderCondition.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -301,9 +301,9 @@ ProviderCondition.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -313,69 +313,69 @@ ProviderCondition.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -383,9 +383,9 @@ ProviderCondition.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -395,38 +395,38 @@ ProviderCondition.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -434,7 +434,7 @@ ProviderCondition.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -444,11 +444,11 @@ ProviderCondition.walletClient #### Parameters -| Name | Type | -| :------------ | :---------------------------------------------- | -| `conditionId` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `conditionId` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -460,9 +460,9 @@ ProviderCondition.abortByTimeOut #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L75) +[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L75) ---- +___ ### call @@ -471,16 +471,16 @@ ProviderCondition.abortByTimeOut #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -492,9 +492,9 @@ ProviderCondition.call #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### checkPermissions @@ -502,11 +502,11 @@ ProviderCondition.call #### Parameters -| Name | Type | -| :-------- | :---------------------------- | -| `grantee` | `string` | -| `did` | `string` | -| `from?` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `grantee` | `string` | +| `did` | `string` | +| `from?` | [`NvmAccount`](NvmAccount.md) | #### Returns @@ -514,9 +514,9 @@ ProviderCondition.call #### Defined in -[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:38](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L38) +[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:38](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L38) ---- +___ ### fulfill @@ -524,13 +524,13 @@ ProviderCondition.call #### Parameters -| Name | Type | -| :------------ | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `grantee` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `grantee` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -542,9 +542,9 @@ ProviderCondition.fulfill #### Defined in -[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:28](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L28) +[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:28](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L28) ---- +___ ### fulfillInstance @@ -552,13 +552,13 @@ ProviderCondition.fulfill #### Parameters -| Name | Type | Default value | -| :----------------- | :-------------------------------------------------------- | :------------ | -| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -570,9 +570,9 @@ ProviderCondition.fulfillInstance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L139) +[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L139) ---- +___ ### fulfillPlain @@ -580,13 +580,13 @@ ProviderCondition.fulfillInstance #### Parameters -| Name | Type | Default value | -| :------------ | :-------------------------------------------------------- | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -598,9 +598,9 @@ ProviderCondition.fulfillPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L47) +[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L47) ---- +___ ### fulfillWithNode @@ -608,12 +608,12 @@ ProviderCondition.fulfillPlain #### Parameters -| Name | Type | -| :----------------- | :----------------------------------------------------- | -| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | -| `additionalParams` | `Record`\<`string`, `unknown`\> | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | +| `additionalParams` | `Record`\<`string`, `unknown`\> | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -625,9 +625,9 @@ ProviderCondition.fulfillWithNode #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L183) +[src/keeper/contracts/conditions/Condition.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L183) ---- +___ ### generateId @@ -635,10 +635,10 @@ ProviderCondition.fulfillWithNode #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -650,9 +650,9 @@ ProviderCondition.generateId #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L61) +[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L61) ---- +___ ### generateIdHash @@ -660,10 +660,10 @@ ProviderCondition.generateId #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `...values` | `any`[] | +| `...values` | `any`[] | #### Returns @@ -675,9 +675,9 @@ ProviderCondition.generateIdHash #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L57) +[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L57) ---- +___ ### generateIdWithSeed @@ -685,10 +685,10 @@ ProviderCondition.generateIdHash #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -700,9 +700,9 @@ ProviderCondition.generateIdWithSeed #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L65) +[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L65) ---- +___ ### getConditionFulfilledEvent @@ -710,8 +710,8 @@ ProviderCondition.generateIdWithSeed #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns @@ -724,9 +724,9 @@ ProviderCondition.getConditionFulfilledEvent #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L79) +[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L79) ---- +___ ### getFromAddress @@ -734,8 +734,8 @@ ProviderCondition.getConditionFulfilledEvent #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -748,24 +748,24 @@ ProviderCondition.getFromAddress #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -773,9 +773,9 @@ ProviderCondition.getTransactionLogs #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### hashValues @@ -783,8 +783,8 @@ ProviderCondition.getTransactionLogs #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -797,9 +797,9 @@ ProviderCondition.hashValues #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L116) +[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L116) ---- +___ ### hashValuesPlain @@ -807,8 +807,8 @@ ProviderCondition.hashValues #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -821,9 +821,9 @@ ProviderCondition.hashValuesPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L122) +[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L122) ---- +___ ### init @@ -831,11 +831,11 @@ ProviderCondition.hashValuesPlain #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -847,9 +847,9 @@ ProviderCondition.init #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instance @@ -857,10 +857,10 @@ ProviderCondition.init #### Parameters -| Name | Type | -| :------------ | :------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | #### Returns @@ -872,9 +872,9 @@ ProviderCondition.instance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L163) +[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L163) ---- +___ ### instanceFromDDO @@ -882,11 +882,11 @@ ProviderCondition.instance #### Parameters -| Name | Type | -| :------------ | :-------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `NFTAccessConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `ctx` | `NFTAccessConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | #### Returns @@ -898,9 +898,9 @@ ProviderCondition.instanceFromDDO #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L131) +[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L131) ---- +___ ### nodeMethod @@ -916,9 +916,9 @@ ProviderCondition.nodeMethod #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L200) +[src/keeper/contracts/conditions/Condition.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L200) ---- +___ ### params @@ -926,9 +926,9 @@ ProviderCondition.nodeMethod #### Parameters -| Name | Type | -| :-------- | :------- | -| `did` | `string` | +| Name | Type | +| :------ | :------ | +| `did` | `string` | | `grantee` | `string` | #### Returns @@ -941,9 +941,9 @@ ProviderCondition.params #### Defined in -[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L20) +[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L20) ---- +___ ### paramsFromDDO @@ -951,8 +951,8 @@ ProviderCondition.params #### Parameters -| Name | Type | -| :--------------- | :-------------------------- | +| Name | Type | +| :------ | :------ | | `«destructured»` | `NFTAccessConditionContext` | #### Returns @@ -965,9 +965,9 @@ ProviderCondition.paramsFromDDO #### Defined in -[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L24) +[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L24) ---- +___ ### send @@ -975,12 +975,12 @@ ProviderCondition.paramsFromDDO #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -992,9 +992,9 @@ ProviderCondition.send #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -1002,12 +1002,12 @@ ProviderCondition.send #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1019,9 +1019,9 @@ ProviderCondition.sendFrom #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -1029,8 +1029,8 @@ ProviderCondition.sendFrom #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1043,9 +1043,9 @@ ProviderCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1053,8 +1053,8 @@ ProviderCondition.setInstanceConfig #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1067,9 +1067,9 @@ ProviderCondition.someLog #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -1077,8 +1077,8 @@ ProviderCondition.someLog #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1091,9 +1091,9 @@ ProviderCondition.getInstance #### Defined in -[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L16) +[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L16) ---- +___ ### setInstanceConfig @@ -1101,15 +1101,15 @@ ProviderCondition.getInstance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1122,4 +1122,4 @@ ProviderCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/NFTAccessService.md b/docs/nevermined-sdk/api-reference/classes/NFTAccessService.md index 4e7075e77f..b723456457 100644 --- a/docs/nevermined-sdk/api-reference/classes/NFTAccessService.md +++ b/docs/nevermined-sdk/api-reference/classes/NFTAccessService.md @@ -55,8 +55,8 @@ #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -69,7 +69,7 @@ #### Defined in -[src/nevermined/AccessService.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L76) +[src/nevermined/AccessService.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L76) ## Properties @@ -79,9 +79,9 @@ #### Defined in -[src/nevermined/AccessService.ts:73](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L73) +[src/nevermined/AccessService.ts:73](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L73) ---- +___ ### normal721 @@ -89,7 +89,7 @@ #### Defined in -[src/nevermined/AccessService.ts:74](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L74) +[src/nevermined/AccessService.ts:74](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L74) ## Accessors @@ -107,9 +107,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -125,9 +125,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -143,9 +143,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -161,9 +161,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -179,9 +179,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -197,9 +197,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -215,9 +215,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -233,9 +233,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -245,69 +245,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -315,9 +315,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -327,38 +327,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -366,7 +366,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -376,8 +376,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------- | :------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | #### Returns @@ -390,9 +390,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/AccessService.ts:113](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L113) +[src/nevermined/AccessService.ts:113](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L113) ---- +___ ### createService @@ -400,13 +400,13 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------------------ | :---------------------------------------------------------------------------- | -| `publisher` | [`NvmAccount`](NvmAccount.md) | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | -| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | -| `pricedData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | +| Name | Type | +| :------ | :------ | +| `publisher` | [`NvmAccount`](NvmAccount.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `pricedData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | #### Returns @@ -418,9 +418,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/AccessService.ts:83](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L83) +[src/nevermined/AccessService.ts:83](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L83) ---- +___ ### process @@ -428,11 +428,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :---------- | :------------------------------------------------------ | -| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -444,9 +444,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/AccessService.ts:104](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L104) +[src/nevermined/AccessService.ts:104](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L104) ---- +___ ### select @@ -454,8 +454,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :----- | :---------------------------------------------- | +| Name | Type | +| :------ | :------ | | `main` | [`MetaDataMain`](../interfaces/MetaDataMain.md) | #### Returns @@ -464,9 +464,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/AccessService.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L100) +[src/nevermined/AccessService.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L100) ---- +___ ### setInstanceConfig @@ -474,8 +474,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -488,9 +488,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### track @@ -498,11 +498,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :---------- | :------------------------------------------------------ | -| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -514,9 +514,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/AccessService.ts:118](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L118) +[src/nevermined/AccessService.ts:118](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L118) ---- +___ ### getInstance @@ -524,8 +524,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -538,9 +538,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -548,15 +548,15 @@ Instantiable.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -569,4 +569,4 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/NFTAccessTemplate.md b/docs/nevermined-sdk/api-reference/classes/NFTAccessTemplate.md index e372f12926..ab3b175633 100644 --- a/docs/nevermined-sdk/api-reference/classes/NFTAccessTemplate.md +++ b/docs/nevermined-sdk/api-reference/classes/NFTAccessTemplate.md @@ -91,8 +91,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -105,7 +105,7 @@ #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) ## Properties @@ -119,9 +119,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -133,9 +133,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -147,9 +147,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -161,9 +161,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -175,7 +175,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -193,9 +193,9 @@ BaseTemplate.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -211,9 +211,9 @@ BaseTemplate.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -229,9 +229,9 @@ BaseTemplate.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -247,9 +247,9 @@ BaseTemplate.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -265,9 +265,9 @@ BaseTemplate.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -283,9 +283,9 @@ BaseTemplate.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -301,9 +301,9 @@ BaseTemplate.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -319,9 +319,9 @@ BaseTemplate.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -331,69 +331,69 @@ BaseTemplate.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -401,9 +401,9 @@ BaseTemplate.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -413,38 +413,38 @@ BaseTemplate.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -452,7 +452,7 @@ BaseTemplate.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -462,8 +462,8 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :------- | :------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | #### Returns @@ -476,9 +476,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/NFTAccessTemplate.ts:133](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTAccessTemplate.ts#L133) +[src/keeper/contracts/templates/NFTAccessTemplate.ts:133](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTAccessTemplate.ts#L133) ---- +___ ### agreementId @@ -486,10 +486,10 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `agreementIdSeed` | `string` | -| `creator` | `string` | +| `creator` | `string` | #### Returns @@ -501,9 +501,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L202) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L202) ---- +___ ### call @@ -512,16 +512,16 @@ BaseTemplate.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -533,9 +533,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### conditions @@ -551,9 +551,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/NFTAccessTemplate.ts:49](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTAccessTemplate.ts#L49) +[src/keeper/contracts/templates/NFTAccessTemplate.ts:49](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTAccessTemplate.ts#L49) ---- +___ ### createAgreement @@ -561,16 +561,16 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `extraArgs` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `extraArgs` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -582,9 +582,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L73) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L73) ---- +___ ### createAgreementAndPay @@ -592,21 +592,21 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :--------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `accessConsumer` | `string` | -| `condIdx` | `number` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `bigint`[] | -| `receivers` | `string`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `accessConsumer` | `string` | +| `condIdx` | `number` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -618,9 +618,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L98) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L98) ---- +___ ### createAgreementFromDDO @@ -630,14 +630,14 @@ Create a new agreement using the data of a DDO. #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :---------- | -| `agreementIdSeed` | `string` | - | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `parameters` | `NFTAccessTemplateParams` | | -| `consumer` | [`NvmAccount`](NvmAccount.md) | - | -| `timeOuts?` | `number`[] | - | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementIdSeed` | `string` | - | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `parameters` | `NFTAccessTemplateParams` | | +| `consumer` | [`NvmAccount`](NvmAccount.md) | - | +| `timeOuts?` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | #### Returns @@ -651,9 +651,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L211) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L211) ---- +___ ### createAgreementWithPaymentFromDDO @@ -661,16 +661,16 @@ true if the call was successful. #### Parameters -| Name | Type | -| :----------------- | :------------------------------------------------------------------------------------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | -| `parameters` | `NFTAccessTemplateParams` | -| `consumer` | [`NvmAccount`](NvmAccount.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | -| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | +| Name | Type | +| :------ | :------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `NFTAccessTemplateParams` | +| `consumer` | [`NvmAccount`](NvmAccount.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | #### Returns @@ -682,9 +682,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L240) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L240) ---- +___ ### createService @@ -692,13 +692,13 @@ true if the call was successful. #### Parameters -| Name | Type | -| :------------------ | :---------------------------------------------------------------------------- | -| `publisher` | [`NvmAccount`](NvmAccount.md) | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | -| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | -| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | +| Name | Type | +| :------ | :------ | +| `publisher` | [`NvmAccount`](NvmAccount.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | #### Returns @@ -710,9 +710,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L48) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L48) ---- +___ ### description @@ -728,9 +728,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/NFTAccessTemplate.ts:38](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTAccessTemplate.ts#L38) +[src/keeper/contracts/templates/NFTAccessTemplate.ts:38](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTAccessTemplate.ts#L38) ---- +___ ### extraGen @@ -738,8 +738,8 @@ true if the call was successful. #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | #### Returns @@ -752,9 +752,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) ---- +___ ### getAgreementCreatedEvent @@ -764,8 +764,8 @@ Generates and returns the agreement creation event. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns @@ -780,23 +780,23 @@ Agreement created event. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L450) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L450) ---- +___ ### getAgreementData -▸ **getAgreementData**(`agreementId`): `Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> +▸ **getAgreementData**(`agreementId`): `Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns -`Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> +`Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> #### Inherited from @@ -804,9 +804,9 @@ Agreement created event. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L29) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L29) ---- +___ ### getAgreementIdsFromDDO @@ -816,12 +816,12 @@ Get agreement conditions IDs. #### Parameters -| Name | Type | Description | -| :------------ | :------------------------ | :------------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `NFTAccessTemplateParams` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | Agreement ID. | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `creator` | `string` | - | +| `params` | `NFTAccessTemplateParams` | - | #### Returns @@ -835,25 +835,25 @@ The condition IDs. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L169) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L169) ---- +___ ### getAgreementStatus -▸ **getAgreementStatus**(`agreementId`): `Promise`\<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> +▸ **getAgreementStatus**(`agreementId`): `Promise`\<``false`` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> Returns the status of the conditions. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns -`Promise`\<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> +`Promise`\<``false`` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> The conditions status. @@ -863,9 +863,9 @@ The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L331) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L331) ---- +___ ### getAgreementsForDID @@ -873,8 +873,8 @@ The conditions status. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -887,9 +887,9 @@ The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L476) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L476) ---- +___ ### getConditionTypes @@ -909,9 +909,9 @@ A list of condition addresses. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L137) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L137) ---- +___ ### getConditions @@ -931,9 +931,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L148) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L148) ---- +___ ### getFromAddress @@ -941,8 +941,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -955,9 +955,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getServiceAgreementTemplate @@ -973,9 +973,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/NFTAccessTemplate.ts:78](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTAccessTemplate.ts#L78) +[src/keeper/contracts/templates/NFTAccessTemplate.ts:78](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTAccessTemplate.ts#L78) ---- +___ ### getServiceAgreementTemplateConditionByRef @@ -983,8 +983,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `ref` | `string` | #### Returns @@ -997,9 +997,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L314) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L314) ---- +___ ### getServiceAgreementTemplateConditions @@ -1015,17 +1015,17 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L309) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L309) ---- +___ ### getServiceAgreementTemplateDependencies -▸ **getServiceAgreementTemplateDependencies**(): `Promise`\<\{ `[condition: string]`: `string`[]; }\> +▸ **getServiceAgreementTemplateDependencies**(): `Promise`\<\{ `[condition: string]`: `string`[]; }\> #### Returns -`Promise`\<\{ `[condition: string]`: `string`[]; }\> +`Promise`\<\{ `[condition: string]`: `string`[]; }\> #### Inherited from @@ -1033,24 +1033,24 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L321) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L321) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -1058,9 +1058,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -1068,11 +1068,11 @@ A list of condition contracts. #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -1084,9 +1084,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instanceFromDDO @@ -1094,12 +1094,12 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :---------------- | :------------------------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `NFTAccessTemplateParams` | +| Name | Type | +| :------ | :------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `parameters` | `NFTAccessTemplateParams` | #### Returns @@ -1111,9 +1111,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/NFTAccessTemplate.ts:54](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTAccessTemplate.ts#L54) +[src/keeper/contracts/templates/NFTAccessTemplate.ts:54](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTAccessTemplate.ts#L54) ---- +___ ### lockConditionIndex @@ -1129,9 +1129,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L57) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L57) ---- +___ ### lockTokens @@ -1139,12 +1139,12 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `tokenAddress` | `any` | +| `amounts` | `any` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1156,9 +1156,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L382) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L382) ---- +___ ### name @@ -1174,9 +1174,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/NFTAccessTemplate.ts:35](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTAccessTemplate.ts#L35) +[src/keeper/contracts/templates/NFTAccessTemplate.ts:35](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTAccessTemplate.ts#L35) ---- +___ ### params @@ -1184,10 +1184,10 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :-------------- | :------- | +| Name | Type | +| :------ | :------ | | `holderAddress` | `string` | -| `amount?` | `bigint` | +| `amount?` | `bigint` | #### Returns @@ -1199,9 +1199,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/NFTAccessTemplate.ts:42](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTAccessTemplate.ts#L42) +[src/keeper/contracts/templates/NFTAccessTemplate.ts:42](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTAccessTemplate.ts#L42) ---- +___ ### paramsGen @@ -1211,8 +1211,8 @@ Specialize params #### Parameters -| Name | Type | Description | -| :--------------- | :------------------------------------------------------ | :----------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `«destructured»` | [`ValidationParams`](../interfaces/ValidationParams.md) | Generic parameters | #### Returns @@ -1225,9 +1225,9 @@ Specialize params #### Defined in -[src/keeper/contracts/templates/NFTAccessTemplate.ts:45](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTAccessTemplate.ts#L45) +[src/keeper/contracts/templates/NFTAccessTemplate.ts:45](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTAccessTemplate.ts#L45) ---- +___ ### paymentData @@ -1235,8 +1235,8 @@ Specialize params #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | #### Returns @@ -1249,9 +1249,9 @@ Specialize params #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L61) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L61) ---- +___ ### printAgreementStatus @@ -1261,8 +1261,8 @@ Prints the agreement status. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns @@ -1275,9 +1275,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L418) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L418) ---- +___ ### process @@ -1285,11 +1285,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :---------- | :------------------------------------------------------ | -| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1301,9 +1301,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/NFTAccessTemplate.ts:101](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTAccessTemplate.ts#L101) +[src/keeper/contracts/templates/NFTAccessTemplate.ts:101](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTAccessTemplate.ts#L101) ---- +___ ### send @@ -1311,12 +1311,12 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1328,9 +1328,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -1338,12 +1338,12 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1355,9 +1355,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### service @@ -1373,9 +1373,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/NFTAccessTemplate.ts:32](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTAccessTemplate.ts#L32) +[src/keeper/contracts/templates/NFTAccessTemplate.ts:32](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTAccessTemplate.ts#L32) ---- +___ ### serviceEndpoint @@ -1391,9 +1391,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L44) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L44) ---- +___ ### setInstanceConfig @@ -1401,8 +1401,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1415,9 +1415,9 @@ Prints the agreement status. #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1425,8 +1425,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1439,9 +1439,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### standardContext @@ -1449,11 +1449,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :-------------- | :-------------- | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `serviceIndex?` | `number` | +| Name | Type | +| :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `serviceIndex?` | `number` | #### Returns @@ -1465,9 +1465,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L189) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L189) ---- +___ ### track @@ -1475,11 +1475,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :---------- | :------------------------------------------------------ | -| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1491,9 +1491,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/NFTAccessTemplate.ts:169](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTAccessTemplate.ts#L169) +[src/keeper/contracts/templates/NFTAccessTemplate.ts:169](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTAccessTemplate.ts#L169) ---- +___ ### validateAgreement @@ -1501,14 +1501,14 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `NFTAccessTemplateParams` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `extra` | `any` | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreement_id` | `string` | +| `did` | `string` | +| `params` | `NFTAccessTemplateParams` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `extra` | `any` | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1520,9 +1520,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/NFTAccessTemplate.ts:116](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTAccessTemplate.ts#L116) +[src/keeper/contracts/templates/NFTAccessTemplate.ts:116](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTAccessTemplate.ts#L116) ---- +___ ### getInstance @@ -1530,8 +1530,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1544,9 +1544,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/NFTAccessTemplate.ts:28](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTAccessTemplate.ts#L28) +[src/keeper/contracts/templates/NFTAccessTemplate.ts:28](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTAccessTemplate.ts#L28) ---- +___ ### setInstanceConfig @@ -1554,15 +1554,15 @@ Prints the agreement status. #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1575,4 +1575,4 @@ Prints the agreement status. #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/NFTAttributes.md b/docs/nevermined-sdk/api-reference/classes/NFTAttributes.md index 785a7d5011..10616f9da0 100644 --- a/docs/nevermined-sdk/api-reference/classes/NFTAttributes.md +++ b/docs/nevermined-sdk/api-reference/classes/NFTAttributes.md @@ -73,9 +73,9 @@ That asset association typically helps to search and filter between assets part #### Defined in -[src/models/AssetAttributes.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L48) +[src/models/AssetAttributes.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L48) ---- +___ ### cap @@ -85,9 +85,9 @@ Max number of nfts that can be minted, 0 means uncapped #### Defined in -[src/models/NFTAttributes.ts:213](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L213) +[src/models/NFTAttributes.ts:213](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L213) ---- +___ ### encryptionMethod @@ -106,9 +106,9 @@ This method allows to specify the encryption method to be used. #### Defined in -[src/models/AssetAttributes.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L21) +[src/models/AssetAttributes.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L21) ---- +___ ### ercType @@ -118,14 +118,14 @@ The type of ERC used (721 or 1155) **`See`** -- [https://ethereum.org/en/developers/docs/standards/tokens/erc-721/](https://ethereum.org/en/developers/docs/standards/tokens/erc-721/) -- [https://ethereum.org/en/developers/docs/standards/tokens/erc-1155/](https://ethereum.org/en/developers/docs/standards/tokens/erc-1155/) + - [https://ethereum.org/en/developers/docs/standards/tokens/erc-721/](https://ethereum.org/en/developers/docs/standards/tokens/erc-721/) + - [https://ethereum.org/en/developers/docs/standards/tokens/erc-1155/](https://ethereum.org/en/developers/docs/standards/tokens/erc-1155/) #### Defined in -[src/models/NFTAttributes.ts:176](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L176) +[src/models/NFTAttributes.ts:176](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L176) ---- +___ ### fulfillAccessTimelock @@ -144,9 +144,9 @@ This would allow to create an agreement that can not fulfilled until certain per #### Defined in -[src/models/AssetAttributes.ts:68](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L68) +[src/models/AssetAttributes.ts:68](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L68) ---- +___ ### fulfillAccessTimeout @@ -165,9 +165,9 @@ This would allow to create an agreement that is not fulfilled after a certain pe #### Defined in -[src/models/AssetAttributes.ts:58](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L58) +[src/models/AssetAttributes.ts:58](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L58) ---- +___ ### metadata @@ -185,9 +185,9 @@ Metadata describing the asset #### Defined in -[src/models/AssetAttributes.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L14) +[src/models/AssetAttributes.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L14) ---- +___ ### nft @@ -197,9 +197,9 @@ Attributes related with the NFT service (access or sales) #### Defined in -[src/models/NFTAttributes.ts:193](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L193) +[src/models/NFTAttributes.ts:193](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L193) ---- +___ ### nftContractAddress @@ -209,9 +209,9 @@ The address of the deployed NFT Contract #### Defined in -[src/models/NFTAttributes.ts:188](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L188) +[src/models/NFTAttributes.ts:188](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L188) ---- +___ ### nftMetadataUrl @@ -221,9 +221,9 @@ URL to the metadata definition of the NFT contract #### Defined in -[src/models/NFTAttributes.ts:208](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L208) +[src/models/NFTAttributes.ts:208](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L208) ---- +___ ### nftType @@ -235,9 +235,9 @@ This attribute allow to specify between the different Nevermined NFT types #### Defined in -[src/models/NFTAttributes.ts:183](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L183) +[src/models/NFTAttributes.ts:183](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L183) ---- +___ ### preMint @@ -247,9 +247,9 @@ If the asset is pre-minted #### Defined in -[src/models/NFTAttributes.ts:203](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L203) +[src/models/NFTAttributes.ts:203](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L203) ---- +___ ### predefinedAssetServices @@ -267,9 +267,9 @@ List of additional asset services to be included as part of an asset #### Defined in -[src/models/AssetAttributes.ts:33](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L33) +[src/models/AssetAttributes.ts:33](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L33) ---- +___ ### providers @@ -287,9 +287,9 @@ Typically just the address of one Nevermined Node trusted by the user. #### Defined in -[src/models/AssetAttributes.ts:42](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L42) +[src/models/AssetAttributes.ts:42](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L42) ---- +___ ### royaltyAttributes @@ -299,9 +299,9 @@ Attributes describing the royalties attached to the NFT in the secondary market #### Defined in -[src/models/NFTAttributes.ts:198](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L198) +[src/models/NFTAttributes.ts:198](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L198) ---- +___ ### services @@ -319,9 +319,9 @@ List of services and their attributes offered by an asset. #### Defined in -[src/models/AssetAttributes.ts:27](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/AssetAttributes.ts#L27) +[src/models/AssetAttributes.ts:27](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/AssetAttributes.ts#L27) ---- +___ ### defaultValues @@ -329,29 +329,29 @@ List of services and their attributes offered by an asset. #### Type declaration -| Name | Type | -| :------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `appId` | `string` | -| `cap` | `bigint` | -| `encryptionMethod` | [`EncryptionMethod`](../code-reference.md#encryptionmethod) | -| `fulfillAccessTimelock` | `number` | -| `fulfillAccessTimeout` | `number` | -| `nft` | \{ `amount`: `bigint` ; `duration`: `number` = 0; `isSubscription`: `boolean` = false; `maxCreditsToCharge`: `bigint` ; `minCreditsRequired`: `bigint` ; `minCreditsToCharge`: `bigint` ; `nftTransfer`: `boolean` = true; `serviceType`: [`ServiceType`](../code-reference.md#servicetype) ; `tokenId`: `string` = '' } | -| `nft.amount` | `bigint` | -| `nft.duration` | `number` | -| `nft.isSubscription` | `boolean` | -| `nft.maxCreditsToCharge` | `bigint` | -| `nft.minCreditsRequired` | `bigint` | -| `nft.minCreditsToCharge` | `bigint` | -| `nft.nftTransfer` | `boolean` | -| `nft.serviceType` | [`ServiceType`](../code-reference.md#servicetype) | -| `nft.tokenId` | `string` | -| `nftMetadataUrl` | `string` | -| `preMint` | `boolean` | -| `predefinedAssetServices` | [`ServiceCommon`](../interfaces/ServiceCommon.md)[] | -| `providers` | `never`[] | -| `royaltyAttributes` | `undefined` | -| `services` | \{ `price`: [`AssetPrice`](AssetPrice.md) ; `serviceType`: [`ServiceType`](../code-reference.md#servicetype) }[] | +| Name | Type | +| :------ | :------ | +| `appId` | `string` | +| `cap` | `bigint` | +| `encryptionMethod` | [`EncryptionMethod`](../code-reference.md#encryptionmethod) | +| `fulfillAccessTimelock` | `number` | +| `fulfillAccessTimeout` | `number` | +| `nft` | \{ `amount`: `bigint` ; `duration`: `number` = 0; `isSubscription`: `boolean` = false; `maxCreditsToCharge`: `bigint` ; `minCreditsRequired`: `bigint` ; `minCreditsToCharge`: `bigint` ; `nftTransfer`: `boolean` = true; `serviceType`: [`ServiceType`](../code-reference.md#servicetype) ; `tokenId`: `string` = '' } | +| `nft.amount` | `bigint` | +| `nft.duration` | `number` | +| `nft.isSubscription` | `boolean` | +| `nft.maxCreditsToCharge` | `bigint` | +| `nft.minCreditsRequired` | `bigint` | +| `nft.minCreditsToCharge` | `bigint` | +| `nft.nftTransfer` | `boolean` | +| `nft.serviceType` | [`ServiceType`](../code-reference.md#servicetype) | +| `nft.tokenId` | `string` | +| `nftMetadataUrl` | `string` | +| `preMint` | `boolean` | +| `predefinedAssetServices` | [`ServiceCommon`](../interfaces/ServiceCommon.md)[] | +| `providers` | `never`[] | +| `royaltyAttributes` | `undefined` | +| `services` | \{ `price`: [`AssetPrice`](AssetPrice.md) ; `serviceType`: [`ServiceType`](../code-reference.md#servicetype) }[] | #### Overrides @@ -359,7 +359,7 @@ List of services and their attributes offered by an asset. #### Defined in -[src/models/NFTAttributes.ts:215](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L215) +[src/models/NFTAttributes.ts:215](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L215) ## Methods @@ -369,8 +369,8 @@ List of services and their attributes offered by an asset. #### Parameters -| Name | Type | -| :-------------- | :----------------------------------------------- | +| Name | Type | +| :------ | :------ | | `nftAttributes` | `Partial`\<[`NFTAttributes`](NFTAttributes.md)\> | #### Returns @@ -379,9 +379,9 @@ List of services and their attributes offered by an asset. #### Defined in -[src/models/NFTAttributes.ts:246](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L246) +[src/models/NFTAttributes.ts:246](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L246) ---- +___ ### getInstance @@ -389,8 +389,8 @@ List of services and their attributes offered by an asset. #### Parameters -| Name | Type | -| :-------------- | :----------------------------------------------- | +| Name | Type | +| :------ | :------ | | `nftAttributes` | `Partial`\<[`NFTAttributes`](NFTAttributes.md)\> | #### Returns @@ -403,9 +403,9 @@ List of services and their attributes offered by an asset. #### Defined in -[src/models/NFTAttributes.ts:224](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L224) +[src/models/NFTAttributes.ts:224](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L224) ---- +___ ### getNFT1155Instance @@ -413,8 +413,8 @@ List of services and their attributes offered by an asset. #### Parameters -| Name | Type | -| :-------------- | :----------------------------------------------- | +| Name | Type | +| :------ | :------ | | `nftAttributes` | `Partial`\<[`NFTAttributes`](NFTAttributes.md)\> | #### Returns @@ -423,9 +423,9 @@ List of services and their attributes offered by an asset. #### Defined in -[src/models/NFTAttributes.ts:235](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L235) +[src/models/NFTAttributes.ts:235](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L235) ---- +___ ### getNFT721Instance @@ -433,8 +433,8 @@ List of services and their attributes offered by an asset. #### Parameters -| Name | Type | -| :-------------- | :----------------------------------------------- | +| Name | Type | +| :------ | :------ | | `nftAttributes` | `Partial`\<[`NFTAttributes`](NFTAttributes.md)\> | #### Returns @@ -443,9 +443,9 @@ List of services and their attributes offered by an asset. #### Defined in -[src/models/NFTAttributes.ts:263](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L263) +[src/models/NFTAttributes.ts:263](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L263) ---- +___ ### getPOAPInstance @@ -453,8 +453,8 @@ List of services and their attributes offered by an asset. #### Parameters -| Name | Type | -| :-------------- | :----------------------------------------------- | +| Name | Type | +| :------ | :------ | | `nftAttributes` | `Partial`\<[`NFTAttributes`](NFTAttributes.md)\> | #### Returns @@ -463,9 +463,9 @@ List of services and their attributes offered by an asset. #### Defined in -[src/models/NFTAttributes.ts:289](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L289) +[src/models/NFTAttributes.ts:289](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L289) ---- +___ ### getSoulBoundInstance @@ -473,8 +473,8 @@ List of services and their attributes offered by an asset. #### Parameters -| Name | Type | -| :-------------- | :----------------------------------------------- | +| Name | Type | +| :------ | :------ | | `nftAttributes` | `Partial`\<[`NFTAttributes`](NFTAttributes.md)\> | #### Returns @@ -483,9 +483,9 @@ List of services and their attributes offered by an asset. #### Defined in -[src/models/NFTAttributes.ts:301](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L301) +[src/models/NFTAttributes.ts:301](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L301) ---- +___ ### getSubscriptionInstance @@ -493,8 +493,8 @@ List of services and their attributes offered by an asset. #### Parameters -| Name | Type | -| :-------------- | :----------------------------------------------- | +| Name | Type | +| :------ | :------ | | `nftAttributes` | `Partial`\<[`NFTAttributes`](NFTAttributes.md)\> | #### Returns @@ -503,4 +503,4 @@ List of services and their attributes offered by an asset. #### Defined in -[src/models/NFTAttributes.ts:274](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L274) +[src/models/NFTAttributes.ts:274](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L274) diff --git a/docs/nevermined-sdk/api-reference/classes/NFTContractsBase.md b/docs/nevermined-sdk/api-reference/classes/NFTContractsBase.md index 21cf03a43a..0fddc4368a 100644 --- a/docs/nevermined-sdk/api-reference/classes/NFTContractsBase.md +++ b/docs/nevermined-sdk/api-reference/classes/NFTContractsBase.md @@ -66,8 +66,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -80,7 +80,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -94,9 +94,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -108,9 +108,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -122,9 +122,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -136,9 +136,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -150,7 +150,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -168,9 +168,9 @@ ContractBase.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -186,9 +186,9 @@ ContractBase.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -204,9 +204,9 @@ ContractBase.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -222,9 +222,9 @@ ContractBase.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -240,9 +240,9 @@ ContractBase.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -258,9 +258,9 @@ ContractBase.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -276,9 +276,9 @@ ContractBase.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -294,9 +294,9 @@ ContractBase.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -306,69 +306,69 @@ ContractBase.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -376,9 +376,9 @@ ContractBase.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -388,38 +388,38 @@ ContractBase.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -427,28 +427,28 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods ### \_createClone -▸ **\_createClone**(`ercType`, `name`, `symbol`, `uri`, `cap`, `operators?`, `from`, `txParams?`): `Promise`\<`any`\> +▸ **_createClone**(`ercType`, `name`, `symbol`, `uri`, `cap`, `operators?`, `from`, `txParams?`): `Promise`\<`any`\> Creates a contract clone of an existing contract instance #### Parameters -| Name | Type | Default value | Description | -| :---------- | :---------------------------------------------- | :------------ | :------------------------------------------------------ | -| `ercType` | `721` \| `1155` | `undefined` | - | -| `name` | `string` | `undefined` | NFT Contract name | -| `symbol` | `string` | `undefined` | NFT Contract symbol | -| `uri` | `string` | `undefined` | NFT Contract metadata uri | -| `cap` | `undefined` \| `bigint` | `undefined` | NFT cap (just for ERC-721) | -| `operators` | `string`[] | `[]` | Array of account addresses to be added as NFT operators | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Sender account | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `ercType` | ``721`` \| ``1155`` | `undefined` | - | +| `name` | `string` | `undefined` | NFT Contract name | +| `symbol` | `string` | `undefined` | NFT Contract symbol | +| `uri` | `string` | `undefined` | NFT Contract metadata uri | +| `cap` | `undefined` \| `bigint` | `undefined` | NFT cap (just for ERC-721) | +| `operators` | `string`[] | `[]` | Array of account addresses to be added as NFT operators | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | #### Returns @@ -458,9 +458,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L41) +[src/keeper/contracts/NFTContractsBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L41) ---- +___ ### call @@ -469,16 +469,16 @@ Contract Receipt #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -490,9 +490,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### getFromAddress @@ -500,8 +500,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -514,44 +514,44 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getNFTAttributes -▸ **getNFTAttributes**(`did`): `Promise`\<\{ `mintCap`: `bigint` ; `nftInitialized`: `boolean` ; `nftSupply`: `bigint` ; `nftURI`: `string` }\> +▸ **getNFTAttributes**(`did`): `Promise`\<\{ `mintCap`: `bigint` ; `nftInitialized`: `boolean` ; `nftSupply`: `bigint` ; `nftURI`: `string` }\> #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns -`Promise`\<\{ `mintCap`: `bigint` ; `nftInitialized`: `boolean` ; `nftSupply`: `bigint` ; `nftURI`: `string` }\> +`Promise`\<\{ `mintCap`: `bigint` ; `nftInitialized`: `boolean` ; `nftSupply`: `bigint` ; `nftURI`: `string` }\> #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L97) +[src/keeper/contracts/NFTContractsBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L97) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -559,9 +559,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### grantOperatorRole @@ -571,11 +571,11 @@ Add an address as operator in the NFT Contract #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :----------------- | -| `operatorAddress` | `string` | New minter address | -| `from` | [`NvmAccount`](NvmAccount.md) | Sender account | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | New minter address | +| `from` | [`NvmAccount`](NvmAccount.md) | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | #### Returns @@ -585,9 +585,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L84) +[src/keeper/contracts/NFTContractsBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L84) ---- +___ ### init @@ -595,11 +595,11 @@ Contract Receipt #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -611,9 +611,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### isOperator @@ -623,8 +623,8 @@ Checks if an account is an operator in the NFT contract #### Parameters -| Name | Type | Description | -| :-------- | :------- | :----------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `address` | `string` | Account address to check if is an operator | #### Returns @@ -635,9 +635,9 @@ true if is an operator #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:93](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L93) +[src/keeper/contracts/NFTContractsBase.ts:93](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L93) ---- +___ ### owner @@ -653,9 +653,9 @@ Address of the contract owner #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L26) +[src/keeper/contracts/NFTContractsBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L26) ---- +___ ### revokeOperatorRole @@ -665,11 +665,11 @@ Revoke an address as operator in the NFT Contract #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :----------------------- | -| `operatorAddress` | `string` | Minter address to revoke | -| `from` | [`NvmAccount`](NvmAccount.md) | Sender account | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | Minter address to revoke | +| `from` | [`NvmAccount`](NvmAccount.md) | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | #### Returns @@ -679,9 +679,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:130](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L130) +[src/keeper/contracts/NFTContractsBase.ts:130](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L130) ---- +___ ### send @@ -689,12 +689,12 @@ Contract Receipt #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -706,9 +706,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -716,12 +716,12 @@ Contract Receipt #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -733,9 +733,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -743,8 +743,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -757,9 +757,9 @@ Contract Receipt #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -767,8 +767,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -781,9 +781,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -791,8 +791,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -805,9 +805,9 @@ Contract Receipt #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -815,15 +815,15 @@ Contract Receipt #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -836,4 +836,4 @@ Contract Receipt #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/NFTError.md b/docs/nevermined-sdk/api-reference/classes/NFTError.md index 313e9f193a..28efa9dff8 100644 --- a/docs/nevermined-sdk/api-reference/classes/NFTError.md +++ b/docs/nevermined-sdk/api-reference/classes/NFTError.md @@ -39,8 +39,8 @@ #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `message` | `string` | #### Returns @@ -53,7 +53,7 @@ Error.constructor #### Defined in -[src/errors/NeverminedErrors.ts:38](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/errors/NeverminedErrors.ts#L38) +[src/errors/NeverminedErrors.ts:38](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/errors/NeverminedErrors.ts#L38) ## Properties @@ -69,7 +69,7 @@ Error.cause node_modules/typescript/lib/lib.es2022.error.d.ts:24 ---- +___ ### message @@ -83,7 +83,7 @@ Error.message node_modules/typescript/lib/lib.es5.d.ts:1077 ---- +___ ### name @@ -97,7 +97,7 @@ Error.name node_modules/typescript/lib/lib.es5.d.ts:1076 ---- +___ ### stack @@ -111,7 +111,7 @@ Error.stack node_modules/typescript/lib/lib.es5.d.ts:1078 ---- +___ ### prepareStackTrace @@ -129,9 +129,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ##### Parameters -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | +| Name | Type | +| :------ | :------ | +| `err` | `Error` | | `stackTraces` | `CallSite`[] | ##### Returns @@ -146,7 +146,7 @@ Error.prepareStackTrace node_modules/@types/node/globals.d.ts:28 ---- +___ ### stackTraceLimit @@ -170,9 +170,9 @@ Create .stack property on a target object #### Parameters -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | | `constructorOpt?` | `Function` | #### Returns diff --git a/docs/nevermined-sdk/api-reference/classes/NFTHolderCondition.md b/docs/nevermined-sdk/api-reference/classes/NFTHolderCondition.md index a3b4a38e24..3bdcf0ee8e 100644 --- a/docs/nevermined-sdk/api-reference/classes/NFTHolderCondition.md +++ b/docs/nevermined-sdk/api-reference/classes/NFTHolderCondition.md @@ -75,8 +75,8 @@ Allows to fulfill a condition to users holding some amount of NFTs for a specifi #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -89,7 +89,7 @@ ConsumerCondition\.constructor #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -103,9 +103,9 @@ ConsumerCondition.address #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -117,9 +117,9 @@ ConsumerCondition.contract #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -131,9 +131,9 @@ ConsumerCondition.contractName #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -145,9 +145,9 @@ ConsumerCondition.events #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -159,7 +159,7 @@ ConsumerCondition.version #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -177,9 +177,9 @@ ConsumerCondition.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -195,9 +195,9 @@ ConsumerCondition.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -213,9 +213,9 @@ ConsumerCondition.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -231,9 +231,9 @@ ConsumerCondition.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -249,9 +249,9 @@ ConsumerCondition.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -267,9 +267,9 @@ ConsumerCondition.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -285,9 +285,9 @@ ConsumerCondition.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -303,9 +303,9 @@ ConsumerCondition.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -315,69 +315,69 @@ ConsumerCondition.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -385,9 +385,9 @@ ConsumerCondition.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -397,38 +397,38 @@ ConsumerCondition.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -436,7 +436,7 @@ ConsumerCondition.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -446,11 +446,11 @@ ConsumerCondition.walletClient #### Parameters -| Name | Type | -| :------------ | :---------------------------------------------- | -| `conditionId` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `conditionId` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -462,9 +462,9 @@ ConsumerCondition.abortByTimeOut #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L75) +[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L75) ---- +___ ### amountFromService @@ -472,8 +472,8 @@ ConsumerCondition.abortByTimeOut #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | #### Returns @@ -482,9 +482,9 @@ ConsumerCondition.abortByTimeOut #### Defined in -[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L44) +[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L44) ---- +___ ### call @@ -493,16 +493,16 @@ ConsumerCondition.abortByTimeOut #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -514,9 +514,9 @@ ConsumerCondition.call #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### fulfill @@ -526,15 +526,15 @@ Fulfill requires a validation that holder as enough NFTs for a specific DID. #### Parameters -| Name | Type | Description | -| :------------------- | :---------------------------------------------- | :----------------------------------------------- | -| `agreementId` | `string` | SEA agreement identifier. | -| `did` | `string` | The Decentralized Identifier of the asset. | -| `holderAddress` | `string` | The contract address where the reward is locked. | -| `amount` | `bigint` | The amount of NFT to be hold | -| `nftContractAddress` | `string` | Address of the nft contract | -| `from` | [`NvmAccount`](NvmAccount.md) | Account sending the transaction | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transacion parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | SEA agreement identifier. | +| `did` | `string` | The Decentralized Identifier of the asset. | +| `holderAddress` | `string` | The contract address where the reward is locked. | +| `amount` | `bigint` | The amount of NFT to be hold | +| `nftContractAddress` | `string` | Address of the nft contract | +| `from` | [`NvmAccount`](NvmAccount.md) | Account sending the transaction | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transacion parameters | #### Returns @@ -548,9 +548,9 @@ ConsumerCondition.fulfill #### Defined in -[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:79](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L79) +[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:79](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L79) ---- +___ ### fulfillInstance @@ -558,13 +558,13 @@ ConsumerCondition.fulfill #### Parameters -| Name | Type | Default value | -| :----------------- | :-------------------------------------------------------- | :------------ | -| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -576,9 +576,9 @@ ConsumerCondition.fulfillInstance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L139) +[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L139) ---- +___ ### fulfillPlain @@ -586,13 +586,13 @@ ConsumerCondition.fulfillInstance #### Parameters -| Name | Type | Default value | -| :------------ | :-------------------------------------------------------- | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -604,9 +604,9 @@ ConsumerCondition.fulfillPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L47) +[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L47) ---- +___ ### fulfillWithNode @@ -614,12 +614,12 @@ ConsumerCondition.fulfillPlain #### Parameters -| Name | Type | -| :------------------ | :----------------------------------------------------- | -| `_cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | -| `_additionalParams` | `Record`\<`string`, `unknown`\> | -| `_from` | [`NvmAccount`](NvmAccount.md) | -| `_txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `_cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | +| `_additionalParams` | `Record`\<`string`, `unknown`\> | +| `_from` | [`NvmAccount`](NvmAccount.md) | +| `_txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -631,9 +631,9 @@ ConsumerCondition.fulfillWithNode #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:209](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L209) +[src/keeper/contracts/conditions/Condition.abstract.ts:209](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L209) ---- +___ ### generateId @@ -641,10 +641,10 @@ ConsumerCondition.fulfillWithNode #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -656,9 +656,9 @@ ConsumerCondition.generateId #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L61) +[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L61) ---- +___ ### generateIdHash @@ -666,10 +666,10 @@ ConsumerCondition.generateId #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `...values` | `any`[] | +| `...values` | `any`[] | #### Returns @@ -681,9 +681,9 @@ ConsumerCondition.generateIdHash #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L57) +[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L57) ---- +___ ### generateIdWithSeed @@ -691,10 +691,10 @@ ConsumerCondition.generateIdHash #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -706,9 +706,9 @@ ConsumerCondition.generateIdWithSeed #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L65) +[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L65) ---- +___ ### getConditionFulfilledEvent @@ -716,8 +716,8 @@ ConsumerCondition.generateIdWithSeed #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns @@ -730,9 +730,9 @@ ConsumerCondition.getConditionFulfilledEvent #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L79) +[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L79) ---- +___ ### getFromAddress @@ -740,8 +740,8 @@ ConsumerCondition.getConditionFulfilledEvent #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -754,24 +754,24 @@ ConsumerCondition.getFromAddress #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -779,9 +779,9 @@ ConsumerCondition.getTransactionLogs #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### hashValues @@ -789,8 +789,8 @@ ConsumerCondition.getTransactionLogs #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -803,9 +803,9 @@ ConsumerCondition.hashValues #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L116) +[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L116) ---- +___ ### hashValuesPlain @@ -813,8 +813,8 @@ ConsumerCondition.hashValues #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -827,9 +827,9 @@ ConsumerCondition.hashValuesPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L122) +[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L122) ---- +___ ### init @@ -837,11 +837,11 @@ ConsumerCondition.hashValuesPlain #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -853,9 +853,9 @@ ConsumerCondition.init #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instance @@ -863,10 +863,10 @@ ConsumerCondition.init #### Parameters -| Name | Type | -| :------------ | :------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | #### Returns @@ -878,9 +878,9 @@ ConsumerCondition.instance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L163) +[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L163) ---- +___ ### instanceFromDDO @@ -888,11 +888,11 @@ ConsumerCondition.instance #### Parameters -| Name | Type | -| :------------ | :-------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `NFTHolderConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `ctx` | `NFTHolderConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | #### Returns @@ -904,9 +904,9 @@ ConsumerCondition.instanceFromDDO #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L131) +[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L131) ---- +___ ### nftContractFromService @@ -914,8 +914,8 @@ ConsumerCondition.instanceFromDDO #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | #### Returns @@ -924,9 +924,9 @@ ConsumerCondition.instanceFromDDO #### Defined in -[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:50](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L50) +[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:50](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L50) ---- +___ ### params @@ -936,12 +936,12 @@ Generate the hash of condition inputs with the following parameters. #### Parameters -| Name | Type | Description | -| :-------------------- | :------- | :---------------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the asset. | -| `holderAddress` | `string` | The address of the NFT holder . | -| `amount` | `bigint` | The amount of NFTs that need to be hold by the holder | -| `nftContractAddress?` | `string` | The address of the NFT token to use. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The Decentralized Identifier of the asset. | +| `holderAddress` | `string` | The address of the NFT holder . | +| `amount` | `bigint` | The amount of NFTs that need to be hold by the holder | +| `nftContractAddress?` | `string` | The address of the NFT token to use. | #### Returns @@ -955,9 +955,9 @@ ConsumerCondition.params #### Defined in -[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:35](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L35) +[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:35](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L35) ---- +___ ### paramsFromDDO @@ -965,8 +965,8 @@ ConsumerCondition.params #### Parameters -| Name | Type | -| :--------------- | :-------------------------- | +| Name | Type | +| :------ | :------ | | `«destructured»` | `NFTHolderConditionContext` | #### Returns @@ -979,9 +979,9 @@ ConsumerCondition.paramsFromDDO #### Defined in -[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L57) +[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L57) ---- +___ ### send @@ -989,12 +989,12 @@ ConsumerCondition.paramsFromDDO #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1006,9 +1006,9 @@ ConsumerCondition.send #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -1016,12 +1016,12 @@ ConsumerCondition.send #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1033,9 +1033,9 @@ ConsumerCondition.sendFrom #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -1043,8 +1043,8 @@ ConsumerCondition.sendFrom #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1057,9 +1057,9 @@ ConsumerCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1067,8 +1067,8 @@ ConsumerCondition.setInstanceConfig #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1081,9 +1081,9 @@ ConsumerCondition.someLog #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -1091,8 +1091,8 @@ ConsumerCondition.someLog #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1105,9 +1105,9 @@ ConsumerCondition.getInstance #### Defined in -[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L22) +[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L22) ---- +___ ### setInstanceConfig @@ -1115,15 +1115,15 @@ ConsumerCondition.getInstance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1136,4 +1136,4 @@ ConsumerCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/NFTLockCondition.md b/docs/nevermined-sdk/api-reference/classes/NFTLockCondition.md index b49ced8f59..9f69c6def4 100644 --- a/docs/nevermined-sdk/api-reference/classes/NFTLockCondition.md +++ b/docs/nevermined-sdk/api-reference/classes/NFTLockCondition.md @@ -73,8 +73,8 @@ Implementation of the NFT Lock Condition #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -87,7 +87,7 @@ ConsumerCondition\.constructor #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -101,9 +101,9 @@ ConsumerCondition.address #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -115,9 +115,9 @@ ConsumerCondition.contract #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -129,9 +129,9 @@ ConsumerCondition.contractName #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -143,9 +143,9 @@ ConsumerCondition.events #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -157,7 +157,7 @@ ConsumerCondition.version #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -175,9 +175,9 @@ ConsumerCondition.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -193,9 +193,9 @@ ConsumerCondition.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -211,9 +211,9 @@ ConsumerCondition.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -229,9 +229,9 @@ ConsumerCondition.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -247,9 +247,9 @@ ConsumerCondition.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -265,9 +265,9 @@ ConsumerCondition.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -283,9 +283,9 @@ ConsumerCondition.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -301,9 +301,9 @@ ConsumerCondition.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -313,69 +313,69 @@ ConsumerCondition.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -383,9 +383,9 @@ ConsumerCondition.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -395,38 +395,38 @@ ConsumerCondition.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -434,7 +434,7 @@ ConsumerCondition.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -444,11 +444,11 @@ ConsumerCondition.walletClient #### Parameters -| Name | Type | -| :------------ | :---------------------------------------------- | -| `conditionId` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `conditionId` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -460,9 +460,9 @@ ConsumerCondition.abortByTimeOut #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L75) +[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L75) ---- +___ ### call @@ -471,16 +471,16 @@ ConsumerCondition.abortByTimeOut #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -492,9 +492,9 @@ ConsumerCondition.call #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### fulfill @@ -504,14 +504,14 @@ Fulfill requires valid NFT transfer in order to lock the amount of DID NFTs base #### Parameters -| Name | Type | Description | -| :-------------- | :---------------------------------------------- | :----------------------------------------------- | -| `agreementId` | `string` | SEA agreement identifier. | -| `did` | `string` | Asset Decentralized identifier. | -| `rewardAddress` | `string` | The contract address where the reward is locked. | -| `amount` | `bigint` | The amount of tokens to be transferred. | -| `from` | [`NvmAccount`](NvmAccount.md) | Account sending the transaction | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | SEA agreement identifier. | +| `did` | `string` | Asset Decentralized identifier. | +| `rewardAddress` | `string` | The contract address where the reward is locked. | +| `amount` | `bigint` | The amount of tokens to be transferred. | +| `from` | [`NvmAccount`](NvmAccount.md) | Account sending the transaction | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -525,9 +525,9 @@ ConsumerCondition.fulfill #### Defined in -[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:49](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L49) +[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:49](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L49) ---- +___ ### fulfillInstance @@ -535,13 +535,13 @@ ConsumerCondition.fulfill #### Parameters -| Name | Type | Default value | -| :----------------- | :-------------------------------------------------------- | :------------ | -| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -553,9 +553,9 @@ ConsumerCondition.fulfillInstance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L139) +[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L139) ---- +___ ### fulfillPlain @@ -563,13 +563,13 @@ ConsumerCondition.fulfillInstance #### Parameters -| Name | Type | Default value | -| :------------ | :-------------------------------------------------------- | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -581,9 +581,9 @@ ConsumerCondition.fulfillPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L47) +[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L47) ---- +___ ### fulfillWithNode @@ -591,12 +591,12 @@ ConsumerCondition.fulfillPlain #### Parameters -| Name | Type | -| :------------------ | :----------------------------------------------------- | -| `_cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | -| `_additionalParams` | `Record`\<`string`, `unknown`\> | -| `_from` | [`NvmAccount`](NvmAccount.md) | -| `_txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `_cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | +| `_additionalParams` | `Record`\<`string`, `unknown`\> | +| `_from` | [`NvmAccount`](NvmAccount.md) | +| `_txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -608,9 +608,9 @@ ConsumerCondition.fulfillWithNode #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:209](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L209) +[src/keeper/contracts/conditions/Condition.abstract.ts:209](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L209) ---- +___ ### generateId @@ -618,10 +618,10 @@ ConsumerCondition.fulfillWithNode #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -633,9 +633,9 @@ ConsumerCondition.generateId #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L61) +[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L61) ---- +___ ### generateIdHash @@ -643,10 +643,10 @@ ConsumerCondition.generateId #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `...values` | `any`[] | +| `...values` | `any`[] | #### Returns @@ -658,9 +658,9 @@ ConsumerCondition.generateIdHash #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L57) +[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L57) ---- +___ ### generateIdWithSeed @@ -668,10 +668,10 @@ ConsumerCondition.generateIdHash #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -683,9 +683,9 @@ ConsumerCondition.generateIdWithSeed #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L65) +[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L65) ---- +___ ### getConditionFulfilledEvent @@ -693,8 +693,8 @@ ConsumerCondition.generateIdWithSeed #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns @@ -707,9 +707,9 @@ ConsumerCondition.getConditionFulfilledEvent #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L79) +[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L79) ---- +___ ### getFromAddress @@ -717,8 +717,8 @@ ConsumerCondition.getConditionFulfilledEvent #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -731,24 +731,24 @@ ConsumerCondition.getFromAddress #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -756,9 +756,9 @@ ConsumerCondition.getTransactionLogs #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### hashValues @@ -766,8 +766,8 @@ ConsumerCondition.getTransactionLogs #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -780,9 +780,9 @@ ConsumerCondition.hashValues #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L116) +[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L116) ---- +___ ### hashValuesPlain @@ -790,8 +790,8 @@ ConsumerCondition.hashValues #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -804,9 +804,9 @@ ConsumerCondition.hashValuesPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L122) +[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L122) ---- +___ ### init @@ -814,11 +814,11 @@ ConsumerCondition.hashValuesPlain #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -830,9 +830,9 @@ ConsumerCondition.init #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instance @@ -840,10 +840,10 @@ ConsumerCondition.init #### Parameters -| Name | Type | -| :------------ | :------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | #### Returns @@ -855,9 +855,9 @@ ConsumerCondition.instance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L163) +[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L163) ---- +___ ### instanceFromDDO @@ -865,11 +865,11 @@ ConsumerCondition.instance #### Parameters -| Name | Type | -| :------------ | :-------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `NFTLockConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `ctx` | `NFTLockConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | #### Returns @@ -881,9 +881,9 @@ ConsumerCondition.instanceFromDDO #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L131) +[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L131) ---- +___ ### params @@ -893,11 +893,11 @@ Generates the hash of condition inputs. #### Parameters -| Name | Type | Description | -| :-------------- | :------- | :----------------------------------------------- | -| `did` | `string` | The DID of the asset with NFTs attached to lock. | -| `rewardAddress` | `string` | The final address to receive the NFTs. | -| `amount` | `number` | The amount of locked tokens. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The DID of the asset with NFTs attached to lock. | +| `rewardAddress` | `string` | The final address to receive the NFTs. | +| `amount` | `number` | The amount of locked tokens. | #### Returns @@ -911,9 +911,9 @@ ConsumerCondition.params #### Defined in -[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:31](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L31) +[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:31](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L31) ---- +___ ### paramsFromDDO @@ -921,8 +921,8 @@ ConsumerCondition.params #### Parameters -| Name | Type | -| :--------------- | :------------------------ | +| Name | Type | +| :------ | :------ | | `«destructured»` | `NFTLockConditionContext` | #### Returns @@ -935,9 +935,9 @@ ConsumerCondition.paramsFromDDO #### Defined in -[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:35](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L35) +[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:35](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L35) ---- +___ ### send @@ -945,12 +945,12 @@ ConsumerCondition.paramsFromDDO #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -962,9 +962,9 @@ ConsumerCondition.send #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -972,12 +972,12 @@ ConsumerCondition.send #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -989,9 +989,9 @@ ConsumerCondition.sendFrom #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -999,8 +999,8 @@ ConsumerCondition.sendFrom #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1013,9 +1013,9 @@ ConsumerCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1023,8 +1023,8 @@ ConsumerCondition.setInstanceConfig #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1037,9 +1037,9 @@ ConsumerCondition.someLog #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -1047,8 +1047,8 @@ ConsumerCondition.someLog #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1061,9 +1061,9 @@ ConsumerCondition.getInstance #### Defined in -[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L20) +[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L20) ---- +___ ### setInstanceConfig @@ -1071,15 +1071,15 @@ ConsumerCondition.getInstance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1092,4 +1092,4 @@ ConsumerCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/NFTSalesService.md b/docs/nevermined-sdk/api-reference/classes/NFTSalesService.md index 789ec1efb3..d93f2435d0 100644 --- a/docs/nevermined-sdk/api-reference/classes/NFTSalesService.md +++ b/docs/nevermined-sdk/api-reference/classes/NFTSalesService.md @@ -55,8 +55,8 @@ #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -69,7 +69,7 @@ #### Defined in -[src/nevermined/AccessService.ts:133](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L133) +[src/nevermined/AccessService.ts:133](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L133) ## Properties @@ -79,9 +79,9 @@ #### Defined in -[src/nevermined/AccessService.ts:130](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L130) +[src/nevermined/AccessService.ts:130](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L130) ---- +___ ### normal721 @@ -89,7 +89,7 @@ #### Defined in -[src/nevermined/AccessService.ts:131](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L131) +[src/nevermined/AccessService.ts:131](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L131) ## Accessors @@ -107,9 +107,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -125,9 +125,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -143,9 +143,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -161,9 +161,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -179,9 +179,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -197,9 +197,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -215,9 +215,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -233,9 +233,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -245,69 +245,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -315,9 +315,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -327,38 +327,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -366,7 +366,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -376,8 +376,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------- | :------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | #### Returns @@ -390,9 +390,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/AccessService.ts:170](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L170) +[src/nevermined/AccessService.ts:170](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L170) ---- +___ ### createService @@ -400,13 +400,13 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------------------ | :---------------------------------------------------------------------------- | -| `publisher` | [`NvmAccount`](NvmAccount.md) | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | -| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | -| `pricedData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | +| Name | Type | +| :------ | :------ | +| `publisher` | [`NvmAccount`](NvmAccount.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `pricedData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | #### Returns @@ -418,9 +418,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/AccessService.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L140) +[src/nevermined/AccessService.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L140) ---- +___ ### process @@ -428,11 +428,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :---------- | :------------------------------------------------------ | -| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -444,9 +444,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/AccessService.ts:161](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L161) +[src/nevermined/AccessService.ts:161](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L161) ---- +___ ### select @@ -454,8 +454,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :----- | :---------------------------------------------- | +| Name | Type | +| :------ | :------ | | `main` | [`MetaDataMain`](../interfaces/MetaDataMain.md) | #### Returns @@ -464,9 +464,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/AccessService.ts:157](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L157) +[src/nevermined/AccessService.ts:157](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L157) ---- +___ ### setInstanceConfig @@ -474,8 +474,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -488,9 +488,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### track @@ -498,11 +498,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :---------- | :------------------------------------------------------ | -| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -514,9 +514,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/AccessService.ts:175](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L175) +[src/nevermined/AccessService.ts:175](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L175) ---- +___ ### getInstance @@ -524,8 +524,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -538,9 +538,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -548,15 +548,15 @@ Instantiable.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -569,4 +569,4 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/NFTSalesTemplate.md b/docs/nevermined-sdk/api-reference/classes/NFTSalesTemplate.md index f8c6523fba..23686279e9 100644 --- a/docs/nevermined-sdk/api-reference/classes/NFTSalesTemplate.md +++ b/docs/nevermined-sdk/api-reference/classes/NFTSalesTemplate.md @@ -92,8 +92,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -106,7 +106,7 @@ #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) ## Properties @@ -120,9 +120,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -134,9 +134,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -148,9 +148,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -162,9 +162,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -176,7 +176,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -194,9 +194,9 @@ BaseTemplate.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -212,9 +212,9 @@ BaseTemplate.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -230,9 +230,9 @@ BaseTemplate.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -248,9 +248,9 @@ BaseTemplate.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -266,9 +266,9 @@ BaseTemplate.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -284,9 +284,9 @@ BaseTemplate.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -302,9 +302,9 @@ BaseTemplate.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -320,9 +320,9 @@ BaseTemplate.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -332,69 +332,69 @@ BaseTemplate.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -402,9 +402,9 @@ BaseTemplate.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -414,38 +414,38 @@ BaseTemplate.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -453,7 +453,7 @@ BaseTemplate.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -463,8 +463,8 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | #### Returns @@ -477,9 +477,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:114](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L114) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:114](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L114) ---- +___ ### agreementId @@ -487,10 +487,10 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `agreementIdSeed` | `string` | -| `creator` | `string` | +| `creator` | `string` | #### Returns @@ -502,9 +502,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L202) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L202) ---- +___ ### call @@ -513,16 +513,16 @@ BaseTemplate.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -534,9 +534,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### conditions @@ -552,9 +552,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/NFTSalesTemplate.ts:96](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTSalesTemplate.ts#L96) +[src/keeper/contracts/templates/NFTSalesTemplate.ts:96](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTSalesTemplate.ts#L96) ---- +___ ### createAgreement @@ -562,16 +562,16 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `extraArgs` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `extraArgs` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -583,9 +583,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L73) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L73) ---- +___ ### createAgreementAndPay @@ -593,21 +593,21 @@ BaseTemplate.walletClient #### Parameters -| Name | Type | -| :--------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `accessConsumer` | `string` | -| `condIdx` | `number` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `bigint`[] | -| `receivers` | `string`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `accessConsumer` | `string` | +| `condIdx` | `number` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -619,9 +619,9 @@ BaseTemplate.walletClient #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L98) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L98) ---- +___ ### createAgreementFromDDO @@ -631,14 +631,14 @@ Create a new agreement using the data of a DDO. #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :---------- | -| `agreementIdSeed` | `string` | - | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `parameters` | `NFTSalesTemplateParams` | | -| `consumer` | [`NvmAccount`](NvmAccount.md) | - | -| `timeOuts?` | `number`[] | - | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementIdSeed` | `string` | - | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `parameters` | `NFTSalesTemplateParams` | | +| `consumer` | [`NvmAccount`](NvmAccount.md) | - | +| `timeOuts?` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | #### Returns @@ -652,9 +652,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L211) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L211) ---- +___ ### createAgreementWithPaymentFromDDO @@ -662,16 +662,16 @@ true if the call was successful. #### Parameters -| Name | Type | -| :----------------- | :------------------------------------------------------------------------------------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | -| `parameters` | `NFTSalesTemplateParams` | -| `consumer` | [`NvmAccount`](NvmAccount.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | -| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | +| Name | Type | +| :------ | :------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `NFTSalesTemplateParams` | +| `consumer` | [`NvmAccount`](NvmAccount.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | #### Returns @@ -683,9 +683,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L240) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L240) ---- +___ ### createService @@ -693,13 +693,13 @@ true if the call was successful. #### Parameters -| Name | Type | -| :------------------ | :---------------------------------------------------------------------------- | -| `publisher` | [`NvmAccount`](NvmAccount.md) | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | -| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | -| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | +| Name | Type | +| :------ | :------ | +| `publisher` | [`NvmAccount`](NvmAccount.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | #### Returns @@ -711,9 +711,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L48) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L48) ---- +___ ### description @@ -729,9 +729,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/NFTSalesTemplate.ts:42](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTSalesTemplate.ts#L42) +[src/keeper/contracts/templates/NFTSalesTemplate.ts:42](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTSalesTemplate.ts#L42) ---- +___ ### extraGen @@ -739,8 +739,8 @@ true if the call was successful. #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | #### Returns @@ -753,9 +753,9 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) ---- +___ ### getAgreementCreatedEvent @@ -765,8 +765,8 @@ Generates and returns the agreement creation event. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns @@ -781,23 +781,23 @@ Agreement created event. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L450) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L450) ---- +___ ### getAgreementData -▸ **getAgreementData**(`agreementId`): `Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> +▸ **getAgreementData**(`agreementId`): `Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns -`Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> +`Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` ; `did`: `string` }\> #### Inherited from @@ -805,9 +805,9 @@ Agreement created event. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L29) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L29) ---- +___ ### getAgreementIdsFromDDO @@ -817,12 +817,12 @@ Get agreement conditions IDs. #### Parameters -| Name | Type | Description | -| :------------ | :----------------------- | :------------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `NFTSalesTemplateParams` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | Agreement ID. | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `creator` | `string` | - | +| `params` | `NFTSalesTemplateParams` | - | #### Returns @@ -836,25 +836,25 @@ The condition IDs. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L169) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L169) ---- +___ ### getAgreementStatus -▸ **getAgreementStatus**(`agreementId`): `Promise`\<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> +▸ **getAgreementStatus**(`agreementId`): `Promise`\<``false`` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> Returns the status of the conditions. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns -`Promise`\<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> +`Promise`\<``false`` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> The conditions status. @@ -864,9 +864,9 @@ The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L331) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L331) ---- +___ ### getAgreementsForDID @@ -874,8 +874,8 @@ The conditions status. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -888,9 +888,9 @@ The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L476) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L476) ---- +___ ### getConditionTypes @@ -910,9 +910,9 @@ A list of condition addresses. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L137) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L137) ---- +___ ### getConditions @@ -932,9 +932,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L148) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L148) ---- +___ ### getFromAddress @@ -942,8 +942,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -956,9 +956,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getParamsFromService @@ -966,11 +966,11 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :----------- | :---------------------------------------------------- | -| `consumerId` | `string` | -| `nftAmount` | `bigint` | -| `service` | [`ServiceNFTSales`](../interfaces/ServiceNFTSales.md) | +| Name | Type | +| :------ | :------ | +| `consumerId` | `string` | +| `nftAmount` | `bigint` | +| `service` | [`ServiceNFTSales`](../interfaces/ServiceNFTSales.md) | #### Returns @@ -978,9 +978,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/NFTSalesTemplate.ts:64](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTSalesTemplate.ts#L64) +[src/keeper/contracts/templates/NFTSalesTemplate.ts:64](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTSalesTemplate.ts#L64) ---- +___ ### getServiceAgreementTemplate @@ -996,9 +996,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/NFTSalesTemplate.ts:147](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTSalesTemplate.ts#L147) +[src/keeper/contracts/templates/NFTSalesTemplate.ts:147](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTSalesTemplate.ts#L147) ---- +___ ### getServiceAgreementTemplateConditionByRef @@ -1006,8 +1006,8 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `ref` | `string` | #### Returns @@ -1020,9 +1020,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L314) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L314) ---- +___ ### getServiceAgreementTemplateConditions @@ -1038,17 +1038,17 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L309) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L309) ---- +___ ### getServiceAgreementTemplateDependencies -▸ **getServiceAgreementTemplateDependencies**(): `Promise`\<\{ `[condition: string]`: `string`[]; }\> +▸ **getServiceAgreementTemplateDependencies**(): `Promise`\<\{ `[condition: string]`: `string`[]; }\> #### Returns -`Promise`\<\{ `[condition: string]`: `string`[]; }\> +`Promise`\<\{ `[condition: string]`: `string`[]; }\> #### Inherited from @@ -1056,24 +1056,24 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L321) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L321) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -1081,9 +1081,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -1091,11 +1091,11 @@ A list of condition contracts. #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -1107,9 +1107,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instanceFromDDO @@ -1117,13 +1117,13 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :---------------- | :----------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `NFTSalesTemplateParams` | -| `serviceIndex?` | `number` | +| Name | Type | +| :------ | :------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `parameters` | `NFTSalesTemplateParams` | +| `serviceIndex?` | `number` | #### Returns @@ -1135,9 +1135,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/NFTSalesTemplate.ts:102](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTSalesTemplate.ts#L102) +[src/keeper/contracts/templates/NFTSalesTemplate.ts:102](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTSalesTemplate.ts#L102) ---- +___ ### lockConditionIndex @@ -1153,9 +1153,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/NFTSalesTemplate.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTSalesTemplate.ts#L92) +[src/keeper/contracts/templates/NFTSalesTemplate.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTSalesTemplate.ts#L92) ---- +___ ### lockTokens @@ -1163,12 +1163,12 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `tokenAddress` | `any` | +| `amounts` | `any` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1180,9 +1180,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L382) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L382) ---- +___ ### name @@ -1198,9 +1198,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/NFTSalesTemplate.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTSalesTemplate.ts#L39) +[src/keeper/contracts/templates/NFTSalesTemplate.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTSalesTemplate.ts#L39) ---- +___ ### params @@ -1208,13 +1208,13 @@ A list of condition contracts. #### Parameters -| Name | Type | -| :------------- | :-------- | -| `consumerId` | `string` | -| `nftAmount` | `bigint` | -| `duration?` | `number` | -| `expiration?` | `number` | -| `providerId?` | `string` | +| Name | Type | +| :------ | :------ | +| `consumerId` | `string` | +| `nftAmount` | `bigint` | +| `duration?` | `number` | +| `expiration?` | `number` | +| `providerId?` | `string` | | `nftTransfer?` | `boolean` | #### Returns @@ -1227,9 +1227,9 @@ A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/NFTSalesTemplate.ts:46](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTSalesTemplate.ts#L46) +[src/keeper/contracts/templates/NFTSalesTemplate.ts:46](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTSalesTemplate.ts#L46) ---- +___ ### paramsGen @@ -1239,8 +1239,8 @@ Specialize params #### Parameters -| Name | Type | Description | -| :--------------- | :------------------------------------------------------ | :----------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `«destructured»` | [`ValidationParams`](../interfaces/ValidationParams.md) | Generic parameters | #### Returns @@ -1253,9 +1253,9 @@ Specialize params #### Defined in -[src/keeper/contracts/templates/NFTSalesTemplate.ts:83](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTSalesTemplate.ts#L83) +[src/keeper/contracts/templates/NFTSalesTemplate.ts:83](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTSalesTemplate.ts#L83) ---- +___ ### paymentData @@ -1263,8 +1263,8 @@ Specialize params #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | #### Returns @@ -1277,9 +1277,9 @@ Specialize params #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L61) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L61) ---- +___ ### printAgreementStatus @@ -1289,8 +1289,8 @@ Prints the agreement status. #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `agreementId` | `string` | Agreement ID. | #### Returns @@ -1303,9 +1303,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L418) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L418) ---- +___ ### process @@ -1313,11 +1313,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :---------- | :------------------------------------------------------ | -| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1329,9 +1329,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:126](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L126) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:126](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L126) ---- +___ ### send @@ -1339,12 +1339,12 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1356,9 +1356,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -1366,12 +1366,12 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1383,9 +1383,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### service @@ -1401,9 +1401,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/NFTSalesTemplate.ts:31](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTSalesTemplate.ts#L31) +[src/keeper/contracts/templates/NFTSalesTemplate.ts:31](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTSalesTemplate.ts#L31) ---- +___ ### serviceEndpoint @@ -1419,9 +1419,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/NFTSalesTemplate.ts:35](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTSalesTemplate.ts#L35) +[src/keeper/contracts/templates/NFTSalesTemplate.ts:35](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTSalesTemplate.ts#L35) ---- +___ ### setInstanceConfig @@ -1429,8 +1429,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1443,9 +1443,9 @@ Prints the agreement status. #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1453,8 +1453,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1467,9 +1467,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### standardContext @@ -1477,11 +1477,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :-------------- | :-------------- | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `serviceIndex?` | `number` | +| Name | Type | +| :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `serviceIndex?` | `number` | #### Returns @@ -1493,9 +1493,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L189) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L189) ---- +___ ### track @@ -1503,11 +1503,11 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :----------- | :------------------------------------------------------ | -| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | -| `_from` | [`NvmAccount`](NvmAccount.md) | -| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `_from` | [`NvmAccount`](NvmAccount.md) | +| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1519,9 +1519,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:118](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L118) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:118](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L118) ---- +___ ### validateAgreement @@ -1529,14 +1529,14 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `NFTSalesTemplateParams` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `extra` | `any` | -| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreement_id` | `string` | +| `did` | `string` | +| `params` | `NFTSalesTemplateParams` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `extra` | `any` | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1548,9 +1548,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L141) +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L141) ---- +___ ### getInstance @@ -1558,8 +1558,8 @@ Prints the agreement status. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1572,9 +1572,9 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/NFTSalesTemplate.ts:27](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/NFTSalesTemplate.ts#L27) +[src/keeper/contracts/templates/NFTSalesTemplate.ts:27](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/NFTSalesTemplate.ts#L27) ---- +___ ### setInstanceConfig @@ -1582,15 +1582,15 @@ Prints the agreement status. #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1603,4 +1603,4 @@ Prints the agreement status. #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/NFTServiceAttributes.md b/docs/nevermined-sdk/api-reference/classes/NFTServiceAttributes.md index e273de9b02..ee89ae18de 100644 --- a/docs/nevermined-sdk/api-reference/classes/NFTServiceAttributes.md +++ b/docs/nevermined-sdk/api-reference/classes/NFTServiceAttributes.md @@ -47,9 +47,9 @@ Number of editions #### Defined in -[src/models/NFTAttributes.ts:17](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L17) +[src/models/NFTAttributes.ts:17](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L17) ---- +___ ### duration @@ -59,9 +59,9 @@ If is a subscription this means the number of blocks the subscription last. If 0 #### Defined in -[src/models/NFTAttributes.ts:32](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L32) +[src/models/NFTAttributes.ts:32](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L32) ---- +___ ### isSubscription @@ -71,9 +71,9 @@ If true means the NFT works as a subscription #### Defined in -[src/models/NFTAttributes.ts:27](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L27) +[src/models/NFTAttributes.ts:27](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L27) ---- +___ ### maxCreditsToCharge @@ -84,9 +84,9 @@ If not specified, the subscription cost is not capped #### Defined in -[src/models/NFTAttributes.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L44) +[src/models/NFTAttributes.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L44) ---- +___ ### minCreditsRequired @@ -97,9 +97,9 @@ If not specified, the amount defined in the service agreement or 1 credit will b #### Defined in -[src/models/NFTAttributes.ts:56](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L56) +[src/models/NFTAttributes.ts:56](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L56) ---- +___ ### minCreditsToCharge @@ -110,9 +110,9 @@ If not specified, the amount defined in the service agreement or 1 credit will b #### Defined in -[src/models/NFTAttributes.ts:50](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L50) +[src/models/NFTAttributes.ts:50](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L50) ---- +___ ### nftTransfer @@ -122,9 +122,9 @@ The asset is transferred (true) or minted (false) with Nevermined contracts #### Defined in -[src/models/NFTAttributes.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L22) +[src/models/NFTAttributes.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L22) ---- +___ ### tokenId @@ -135,9 +135,9 @@ For example if is a NFT Access service requiring holding a NFT, this is the toke #### Defined in -[src/models/NFTAttributes.ts:38](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L38) +[src/models/NFTAttributes.ts:38](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L38) ---- +___ ### defaultValues @@ -145,21 +145,21 @@ For example if is a NFT Access service requiring holding a NFT, this is the toke #### Type declaration -| Name | Type | -| :------------------- | :------------------------------------------------ | -| `amount` | `bigint` | -| `duration` | `number` | -| `isSubscription` | `boolean` | -| `maxCreditsToCharge` | `bigint` | -| `minCreditsRequired` | `bigint` | -| `minCreditsToCharge` | `bigint` | -| `nftTransfer` | `boolean` | -| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | -| `tokenId` | `string` | +| Name | Type | +| :------ | :------ | +| `amount` | `bigint` | +| `duration` | `number` | +| `isSubscription` | `boolean` | +| `maxCreditsToCharge` | `bigint` | +| `minCreditsRequired` | `bigint` | +| `minCreditsToCharge` | `bigint` | +| `nftTransfer` | `boolean` | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | +| `tokenId` | `string` | #### Defined in -[src/models/NFTAttributes.ts:58](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L58) +[src/models/NFTAttributes.ts:58](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L58) ## Methods @@ -171,8 +171,8 @@ Given some partial nft attributes it applies some default validations and pre-co #### Parameters -| Name | Type | Description | -| :-------------- | :----------------------------------------------- | :--------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `nftAttributes` | `Partial`\<[`NFTAttributes`](NFTAttributes.md)\> | partial nft attributes | #### Returns @@ -183,9 +183,9 @@ nft attributes validated and configured #### Defined in -[src/models/NFTAttributes.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L136) +[src/models/NFTAttributes.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L136) ---- +___ ### getCreditsToCharge @@ -195,11 +195,11 @@ Taking into account the nft attributes confifured tt returns the number of credi #### Parameters -| Name | Type | Default value | Description | -| :--------------- | :------------------------------------------------ | :----------------- | :------------------------------------------------- | -| `nftAttributes` | [`NFTServiceAttributes`](NFTServiceAttributes.md) | `undefined` | - | -| `chargeType` | [`ChargeType`](../enums/ChargeType.md) | `ChargeType.Fixed` | - | -| `dynamicAmount?` | `bigint` | `undefined` | the dynamic amount of credits asked to be consumed | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `nftAttributes` | [`NFTServiceAttributes`](NFTServiceAttributes.md) | `undefined` | - | +| `chargeType` | [`ChargeType`](../enums/ChargeType.md) | `ChargeType.Fixed` | - | +| `dynamicAmount?` | `bigint` | `undefined` | the dynamic amount of credits asked to be consumed | #### Returns @@ -209,9 +209,9 @@ amount to consume #### Defined in -[src/models/NFTAttributes.ts:81](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L81) +[src/models/NFTAttributes.ts:81](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L81) ---- +___ ### getDefaultNFTServiceAttributes @@ -223,9 +223,9 @@ amount to consume #### Defined in -[src/models/NFTAttributes.ts:70](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L70) +[src/models/NFTAttributes.ts:70](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L70) ---- +___ ### isCreditsBalanceEnough @@ -235,11 +235,11 @@ Given some credits balance if checks if that's enough to access to a NFT asset #### Parameters -| Name | Type | Description | -| :--------------- | :------------------------------------------------ | :----------------------------------------------- | -| `nftAttributes` | [`NFTServiceAttributes`](NFTServiceAttributes.md) | NFT Attributes metadata | -| `creditsBalance` | `bigint` | balance of credits | -| `dynamicAmount?` | `bigint` | the dynamic amount of credits asked to be burned | +| Name | Type | Description | +| :------ | :------ | :------ | +| `nftAttributes` | [`NFTServiceAttributes`](NFTServiceAttributes.md) | NFT Attributes metadata | +| `creditsBalance` | `bigint` | balance of credits | +| `dynamicAmount?` | `bigint` | the dynamic amount of credits asked to be burned | #### Returns @@ -249,4 +249,4 @@ boolean #### Defined in -[src/models/NFTAttributes.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NFTAttributes.ts#L115) +[src/models/NFTAttributes.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NFTAttributes.ts#L115) diff --git a/docs/nevermined-sdk/api-reference/classes/NFTsBaseApi.md b/docs/nevermined-sdk/api-reference/classes/NFTsBaseApi.md index dfc5ef28ce..e53c0228ef 100644 --- a/docs/nevermined-sdk/api-reference/classes/NFTsBaseApi.md +++ b/docs/nevermined-sdk/api-reference/classes/NFTsBaseApi.md @@ -89,7 +89,7 @@ Abstract class providing common NFT methods for different ERC implementations. #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L39) +[src/nevermined/api/RegistryBaseApi.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L39) ## Accessors @@ -107,9 +107,9 @@ RegistryBaseApi.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -125,9 +125,9 @@ RegistryBaseApi.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -143,9 +143,9 @@ RegistryBaseApi.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -161,9 +161,9 @@ RegistryBaseApi.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -179,9 +179,9 @@ RegistryBaseApi.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -197,9 +197,9 @@ RegistryBaseApi.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -215,9 +215,9 @@ RegistryBaseApi.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -233,9 +233,9 @@ RegistryBaseApi.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -245,69 +245,69 @@ RegistryBaseApi.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -315,9 +315,9 @@ RegistryBaseApi.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -327,38 +327,38 @@ RegistryBaseApi.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -366,26 +366,26 @@ RegistryBaseApi.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods ### \_details -▸ **\_details**(`did`, `ercType`): `Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> +▸ **_details**(`did`, `ercType`): `Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> Get the details of an NFT #### Parameters -| Name | Type | Description | -| :-------- | :------------------------------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `ercType` | [`ERCType`](../enums/ERCType.md) | The type of NFT used | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `ercType` | [`ERCType`](../enums/ERCType.md) | The type of NFT used | #### Returns -`Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> +`Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> The details of the NFT. @@ -405,9 +405,9 @@ assert.equal(details.owner, artist.getId()) #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:152](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L152) +[src/nevermined/api/nfts/NFTsBaseApi.ts:152](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L152) ---- +___ ### access @@ -417,16 +417,16 @@ Access the files associated with an NFT. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------------------------------ | -| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The user account holding NFTs (after purchase) requesting the access | -| `destination?` | `string` | `undefined` | The download destination for the files. | -| `fileIndex?` | `number` | `undefined` | The index of the file. If unset will download all the files in the asset. | -| `agreementId` | `string` | `'0x'` | The NFT sales agreement id. | -| `buyer?` | `string` | `undefined` | Key which represent the buyer | -| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | - | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service reference to use. By default is nft-access. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The user account holding NFTs (after purchase) requesting the access | +| `destination?` | `string` | `undefined` | The download destination for the files. | +| `fileIndex?` | `number` | `undefined` | The index of the file. If unset will download all the files in the asset. | +| `agreementId` | `string` | `'0x'` | The NFT sales agreement id. | +| `buyer?` | `string` | `undefined` | Key which represent the buyer | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | - | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service reference to use. By default is nft-access. | #### Returns @@ -447,9 +447,9 @@ const result = await nevermined.nfts1155.access(ddo.id, collector, '/tmp/') #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:427](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L427) +[src/nevermined/api/nfts/NFTsBaseApi.ts:427](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L427) ---- +___ ### addRating @@ -459,14 +459,14 @@ Given a DID, it adds a vote to the asset curation information. #### Parameters -| Name | Type | Default value | Description | -| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `newRating` | `number` | `undefined` | New average rating of the asset | -| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `newRating` | `number` | `undefined` | New average rating of the asset | +| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -480,9 +480,9 @@ Given a DID, it adds a vote to the asset curation information. #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:534](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L534) +[src/nevermined/api/RegistryBaseApi.ts:534](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L534) ---- +___ ### buySecondaryMarketNft @@ -492,13 +492,13 @@ Buys a number of listed NFTs on secondary markets. #### Parameters -| Name | Type | Description | -| :------------------ | :---------------------------------------------- | :--------------------------------------------------------- | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the buyer/consumer. | -| `nftAmount` | `bigint` | The number of assets to buy. 1 by default. | -| `agreementIdSeed` | `string` | The seed of the initial sales agreement created off-chain. | -| `conditionsTimeout` | `number`[] | The timeout for the conditions. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the buyer/consumer. | +| `nftAmount` | `bigint` | The number of assets to buy. 1 by default. | +| `agreementIdSeed` | `string` | The seed of the initial sales agreement created off-chain. | +| `conditionsTimeout` | `number`[] | The timeout for the conditions. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -509,7 +509,11 @@ true if the buy was successful. **`Example`** ```ts -const result = await nevermined.nfts1155.buySecondaryMarketNft(collector, 1n, agreementId) +const result = await nevermined.nfts1155.buySecondaryMarketNft( + collector, + 1n, + agreementId + ) ``` **`Throws`** @@ -519,9 +523,9 @@ Thrown if there is an error buying the NFT. #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:345](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L345) +[src/nevermined/api/nfts/NFTsBaseApi.ts:345](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L345) ---- +___ ### claimNFT @@ -531,15 +535,15 @@ Claims the transfer of a NFT to the Nevermined Node on behalf of the publisher. #### Parameters -| Name | Type | Default value | Description | -| :--------------- | :------------------------------- | :------------ | :--------------------------------------------------------------------------- | -| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | -| `nftHolder` | `string` | `undefined` | The address of the current owner of the NFT. | -| `nftReceiver` | `string` | `undefined` | The address where the NFT should be transferred. | -| `numberEditions` | `bigint` | `undefined` | The number of NFT editions to transfer. If the NFT is ERC-721 it should be 1 | -| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The Type of the NFT ERC (1155 or 721). | -| `did?` | `string` | `undefined` | The DID of the asset. | -| `serviceIndex?` | `number` | `undefined` | The index of the service in the DDO that will be claimed | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `nftHolder` | `string` | `undefined` | The address of the current owner of the NFT. | +| `nftReceiver` | `string` | `undefined` | The address where the NFT should be transferred. | +| `numberEditions` | `bigint` | `undefined` | The number of NFT editions to transfer. If the NFT is ERC-721 it should be 1 | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The Type of the NFT ERC (1155 or 721). | +| `did?` | `string` | `undefined` | The DID of the asset. | +| `serviceIndex?` | `number` | `undefined` | The index of the service in the DDO that will be claimed | #### Returns @@ -560,12 +564,12 @@ as soon as the payment is made ```ts const receipt = await nevermined.nfts721.claim( - agreementId, - editor.getId(), - subscriber.getId(), - nftAmount, - 721, -) + agreementId, + editor.getId(), + subscriber.getId(), + nftAmount, + 721 + ) ``` **`Throws`** @@ -574,9 +578,9 @@ const receipt = await nevermined.nfts721.claim( #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L52) +[src/nevermined/api/nfts/NFTsBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L52) ---- +___ ### getSubscriptionToken @@ -586,10 +590,10 @@ Get a JWT token for an asset associated with a webService #### Parameters -| Name | Type | Description | -| :----- | :---------------------------- | :----------------------------------------------------------------------------- | -| `did` | `string` | The did of the asset with a webService resource and an associated subscription | -| `from` | [`NvmAccount`](NvmAccount.md) | Account of the user requesting the token | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The did of the asset with a webService resource and an associated subscription | +| `from` | [`NvmAccount`](NvmAccount.md) | Account of the user requesting the token | #### Returns @@ -608,9 +612,9 @@ assert.isDefined(response.neverminedProxyUri) #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:490](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L490) +[src/nevermined/api/nfts/NFTsBaseApi.ts:490](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L490) ---- +___ ### isOperator @@ -620,11 +624,11 @@ Check if a particular address is the operator of given a NFT address. #### Parameters -| Name | Type | Default value | Description | -| :------------------- | :------------------------------- | :------------ | :-------------------------------------- | -| `nftContractAddress` | `string` | `undefined` | The DID of the NFT to check | -| `operatorAddress` | `string` | `undefined` | The address to check if operator status | -| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `nftContractAddress` | `string` | `undefined` | The DID of the NFT to check | +| `operatorAddress` | `string` | `undefined` | The address to check if operator status | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | #### Returns @@ -634,9 +638,9 @@ operator status of address as a boolean #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:118](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L118) +[src/nevermined/api/nfts/NFTsBaseApi.ts:118](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L118) ---- +___ ### isOperatorOfDID @@ -646,11 +650,11 @@ Check if a particular address is the operator of a DID. #### Parameters -| Name | Type | Default value | Description | -| :-------- | :------------------------------- | :------------ | :-------------------------------------- | -| `did` | `string` | `undefined` | The DID of the NFT to check | -| `address` | `string` | `undefined` | The address to check if operator status | -| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | The DID of the NFT to check | +| `address` | `string` | `undefined` | The address to check if operator status | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | #### Returns @@ -660,9 +664,9 @@ operator status of address as a boolean #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:93](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L93) +[src/nevermined/api/nfts/NFTsBaseApi.ts:93](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L93) ---- +___ ### list @@ -673,13 +677,13 @@ In a Nevermined environment, when an asset is unlisted, it is not possible to be #### Parameters -| Name | Type | Default value | Description | -| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -693,9 +697,9 @@ In a Nevermined environment, when an asset is unlisted, it is not possible to be #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:482](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L482) +[src/nevermined/api/RegistryBaseApi.ts:482](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L482) ---- +___ ### listOnSecondaryMarkets @@ -705,15 +709,15 @@ After purchase re-list an NFT to enable secondary market sales. #### Parameters -| Name | Type | Description | -| :------------ | :---------------------------- | :----------------------------------------------------------- | -| `ddo` | [`DDO`](DDO.md) | The DDO of the asset. | -| `assetPrice` | [`AssetPrice`](AssetPrice.md) | The current setup of asset rewards. | -| `nftAmount` | `bigint` | The number of NFTs put up for secondary sale. | -| `nftTransfer` | `boolean` | - | -| `provider` | `string` | The address that will be the provider of the secondary sale. | -| `token` | [`Token`](Token.md) | - | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the current owner. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | The DDO of the asset. | +| `assetPrice` | [`AssetPrice`](AssetPrice.md) | The current setup of asset rewards. | +| `nftAmount` | `bigint` | The number of NFTs put up for secondary sale. | +| `nftTransfer` | `boolean` | - | +| `provider` | `string` | The address that will be the provider of the secondary sale. | +| `token` | [`Token`](Token.md) | - | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the current owner. | #### Returns @@ -725,13 +729,13 @@ the agreementId of the secondary sale. ```ts const agreementId = await nevermined.nfts1155.listOnSecondaryMarkets( - ddo, - assetPrice, - numberNFTs, - collector.getId(), - token, - collector.getId(), -) + ddo, + assetPrice, + numberNFTs, + collector.getId(), + token, + collector.getId() + ) ``` **`Throws`** @@ -741,9 +745,9 @@ Thrown if there is an error listing the NFT. #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:262](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L262) +[src/nevermined/api/nfts/NFTsBaseApi.ts:262](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L262) ---- +___ ### orderAsset @@ -754,12 +758,12 @@ then sends the request to the publisher via the service endpoint (Node http serv #### Parameters -| Name | Type | Description | -| :----------------- | :------------------------------------------------------------ | :--------------------- | -| `did` | `string` | Decentralized ID. | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | -| `from` | [`NvmAccount`](NvmAccount.md) | Consumer account. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | Decentralized ID. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `from` | [`NvmAccount`](NvmAccount.md) | Consumer account. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -773,9 +777,9 @@ The agreement ID. #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:585](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L585) +[src/nevermined/api/RegistryBaseApi.ts:585](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L585) ---- +___ ### registerNeverminedAsset @@ -786,13 +790,13 @@ via the Nevermined APIs directly. It must accessed via the `assets`, `compute`, #### Parameters -| Name | Type | Description | -| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | -| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | +| Name | Type | Description | +| :------ | :------ | :------ | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | | `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -810,9 +814,9 @@ The metadata of the asset created (DDO) #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L52) +[src/nevermined/api/RegistryBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L52) ---- +___ ### resolveAsset @@ -823,9 +827,9 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Parameters -| Name | Type | Default value | Description | -| :------- | :------------------------------------------------- | :---------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID. | | `policy` | [`DIDResolvePolicy`](../enums/DIDResolvePolicy.md) | `DIDResolvePolicy.MetadataAPIFirst` | It specifies the resolve policy to apply. It allows to select that priorities during the asset resolution via Metadata API or Immutable URLs (IPFS, Filecoin, etc) | #### Returns @@ -840,9 +844,9 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:324](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L324) +[src/nevermined/api/RegistryBaseApi.ts:324](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L324) ---- +___ ### setInstanceConfig @@ -850,8 +854,8 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -864,9 +868,9 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### updateAsset @@ -876,13 +880,13 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Parameters -| Name | Type | Default value | Description | -| :----------------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -896,9 +900,9 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:367](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L367) +[src/nevermined/api/RegistryBaseApi.ts:367](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L367) ---- +___ ### getInstance @@ -906,8 +910,8 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -920,9 +924,9 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### getNFTContractAddress @@ -932,9 +936,9 @@ Gets the NFT contract address associated with a Nevermined asset from the DDO. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------ | -| `ddo` | [`DDO`](DDO.md) | `undefined` | The DDO of the asset. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | `undefined` | The DDO of the asset. | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service type to look for the contract address | #### Returns @@ -951,9 +955,9 @@ const nftContractAddress = NFT1155Api.getNFTContractAddress(ddo) #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:221](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L221) +[src/nevermined/api/nfts/NFTsBaseApi.ts:221](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L221) ---- +___ ### getServicePlugin @@ -963,8 +967,8 @@ Initializes the default Nevermined service plugins and return that instance #### Parameters -| Name | Type | Description | -| :------- | :---------------------------------------------------------- | :---------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Nevermined config | #### Returns @@ -973,12 +977,12 @@ Initializes the default Nevermined service plugins and return that instance The Nevermined Service Plugin instance -| Name | Type | -| :----------- | :-------------------------------------------------------------------- | -| `access` | [`AccessService`](AccessService.md) | -| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | -| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | -| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | +| Name | Type | +| :------ | :------ | +| `access` | [`AccessService`](AccessService.md) | +| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | +| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | +| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | #### Inherited from @@ -986,9 +990,9 @@ The Nevermined Service Plugin instance #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:640](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L640) +[src/nevermined/api/RegistryBaseApi.ts:640](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L640) ---- +___ ### setInstanceConfig @@ -996,15 +1000,15 @@ The Nevermined Service Plugin instance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1017,4 +1021,4 @@ The Nevermined Service Plugin instance #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/Nevermined.md b/docs/nevermined-sdk/api-reference/classes/Nevermined.md index fe49e085ca..f64e88a23d 100644 --- a/docs/nevermined-sdk/api-reference/classes/Nevermined.md +++ b/docs/nevermined-sdk/api-reference/classes/Nevermined.md @@ -31,7 +31,7 @@ Main interface for Nevermined Protocol. - [search](Nevermined.md#search) - [services](Nevermined.md#services) - [utils](Nevermined.md#utils) -- [DEFAULT_INITIALIZATION_OPTIONS](Nevermined.md#default_initialization_options) +- [DEFAULT\_INITIALIZATION\_OPTIONS](Nevermined.md#default_initialization_options) ### Accessors @@ -69,7 +69,7 @@ Main interface for Nevermined Protocol. #### Defined in -[src/nevermined/Nevermined.ts:263](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Nevermined.ts#L263) +[src/nevermined/Nevermined.ts:263](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Nevermined.ts#L263) ## Properties @@ -81,9 +81,9 @@ Accounts submodule #### Defined in -[src/nevermined/Nevermined.ts:206](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Nevermined.ts#L206) +[src/nevermined/Nevermined.ts:206](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Nevermined.ts#L206) ---- +___ ### agreements @@ -93,9 +93,9 @@ Agreements submodule #### Defined in -[src/nevermined/Nevermined.ts:211](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Nevermined.ts#L211) +[src/nevermined/Nevermined.ts:211](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Nevermined.ts#L211) ---- +___ ### assets @@ -105,9 +105,9 @@ Assets API #### Defined in -[src/nevermined/Nevermined.ts:216](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Nevermined.ts#L216) +[src/nevermined/Nevermined.ts:216](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Nevermined.ts#L216) ---- +___ ### compute @@ -117,9 +117,9 @@ Compute API #### Defined in -[src/nevermined/Nevermined.ts:221](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Nevermined.ts#L221) +[src/nevermined/Nevermined.ts:221](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Nevermined.ts#L221) ---- +___ ### contracts @@ -129,21 +129,21 @@ Nevermined very own contract reflector. #### Type declaration -| Name | Type | Description | -| :-------------------- | :----------------------------------------------------------------------------------- | :---------- | -| `loadErc20` | (`address`: `string`) => `Promise`\<[`CustomToken`](CustomToken.md)\> | - | -| `loadNft1155` | (`address`: `string`) => `Promise`\<[`NFT1155Api`](NFT1155Api.md)\> | - | -| `loadNft1155Api` | (`api`: [`NFT1155Api`](NFT1155Api.md)) => `Promise`\<[`NFT1155Api`](NFT1155Api.md)\> | - | -| `loadNft1155Contract` | (`address`: `string`) => `Promise`\<[`Nft1155Contract`](Nft1155Contract.md)\> | - | -| `loadNft721` | (`address`: `string`) => `Promise`\<[`NFT721Api`](NFT721Api.md)\> | - | -| `loadNft721Api` | (`api`: [`NFT721Api`](NFT721Api.md)) => `Promise`\<[`NFT721Api`](NFT721Api.md)\> | - | -| `loadNft721Contract` | (`address`: `string`) => `Promise`\<[`Nft721Contract`](Nft721Contract.md)\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `loadErc20` | (`address`: `string`) => `Promise`\<[`CustomToken`](CustomToken.md)\> | - | +| `loadNft1155` | (`address`: `string`) => `Promise`\<[`NFT1155Api`](NFT1155Api.md)\> | - | +| `loadNft1155Api` | (`api`: [`NFT1155Api`](NFT1155Api.md)) => `Promise`\<[`NFT1155Api`](NFT1155Api.md)\> | - | +| `loadNft1155Contract` | (`address`: `string`) => `Promise`\<[`Nft1155Contract`](Nft1155Contract.md)\> | - | +| `loadNft721` | (`address`: `string`) => `Promise`\<[`NFT721Api`](NFT721Api.md)\> | - | +| `loadNft721Api` | (`api`: [`NFT721Api`](NFT721Api.md)) => `Promise`\<[`NFT721Api`](NFT721Api.md)\> | - | +| `loadNft721Contract` | (`address`: `string`) => `Promise`\<[`Nft721Contract`](Nft721Contract.md)\> | - | #### Defined in -[src/nevermined/Nevermined.ts:121](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Nevermined.ts#L121) +[src/nevermined/Nevermined.ts:121](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Nevermined.ts#L121) ---- +___ ### isKeeperConnected @@ -153,9 +153,9 @@ If keeper is connected #### Defined in -[src/nevermined/Nevermined.ts:261](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Nevermined.ts#L261) +[src/nevermined/Nevermined.ts:261](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Nevermined.ts#L261) ---- +___ ### keeper @@ -165,9 +165,9 @@ Keeper instance. #### Defined in -[src/nevermined/Nevermined.ts:201](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Nevermined.ts#L201) +[src/nevermined/Nevermined.ts:201](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Nevermined.ts#L201) ---- +___ ### nfts1155 @@ -177,9 +177,9 @@ ERC-1155 Nfts API #### Defined in -[src/nevermined/Nevermined.ts:226](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Nevermined.ts#L226) +[src/nevermined/Nevermined.ts:226](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Nevermined.ts#L226) ---- +___ ### nfts721 @@ -189,9 +189,9 @@ ERC-721 Nfts API #### Defined in -[src/nevermined/Nevermined.ts:231](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Nevermined.ts#L231) +[src/nevermined/Nevermined.ts:231](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Nevermined.ts#L231) ---- +___ ### provenance @@ -201,9 +201,9 @@ Provenance submodule #### Defined in -[src/nevermined/Nevermined.ts:236](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Nevermined.ts#L236) +[src/nevermined/Nevermined.ts:236](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Nevermined.ts#L236) ---- +___ ### search @@ -213,9 +213,9 @@ SearchApi API #### Defined in -[src/nevermined/Nevermined.ts:241](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Nevermined.ts#L241) +[src/nevermined/Nevermined.ts:241](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Nevermined.ts#L241) ---- +___ ### services @@ -225,9 +225,9 @@ SearchApi API #### Defined in -[src/nevermined/Nevermined.ts:246](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Nevermined.ts#L246) +[src/nevermined/Nevermined.ts:246](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Nevermined.ts#L246) ---- +___ ### utils @@ -237,17 +237,17 @@ Utils submodule #### Defined in -[src/nevermined/Nevermined.ts:251](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Nevermined.ts#L251) +[src/nevermined/Nevermined.ts:251](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Nevermined.ts#L251) ---- +___ -### DEFAULT_INITIALIZATION_OPTIONS +### DEFAULT\_INITIALIZATION\_OPTIONS -▪ `Static` **DEFAULT_INITIALIZATION_OPTIONS**: [`NeverminedInitializationOptions`](../interfaces/NeverminedInitializationOptions.md) +▪ `Static` **DEFAULT\_INITIALIZATION\_OPTIONS**: [`NeverminedInitializationOptions`](../interfaces/NeverminedInitializationOptions.md) #### Defined in -[src/nevermined/Nevermined.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Nevermined.ts#L24) +[src/nevermined/Nevermined.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Nevermined.ts#L24) ## Accessors @@ -265,9 +265,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -283,9 +283,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -301,9 +301,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -319,9 +319,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -337,9 +337,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -355,9 +355,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -373,9 +373,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -391,9 +391,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -403,69 +403,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -473,9 +473,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -485,38 +485,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -524,7 +524,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -534,8 +534,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -548,9 +548,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### getInstance @@ -560,10 +560,10 @@ Returns the instance of Nevermined. #### Parameters -| Name | Type | Description | -| :------------ | :------------------------------------------------------------------------------------ | :--------------------------------- | -| `config` | [`NeverminedOptions`](NeverminedOptions.md) | Nevermined instance configuration. | -| `initOptions` | [`NeverminedInitializationOptions`](../interfaces/NeverminedInitializationOptions.md) | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `config` | [`NeverminedOptions`](NeverminedOptions.md) | Nevermined instance configuration. | +| `initOptions` | [`NeverminedInitializationOptions`](../interfaces/NeverminedInitializationOptions.md) | - | #### Returns @@ -586,9 +586,9 @@ const nevermined = await Nevermined.getInstance(config) #### Defined in -[src/nevermined/Nevermined.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Nevermined.ts#L51) +[src/nevermined/Nevermined.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Nevermined.ts#L51) ---- +___ ### getSearchOnlyInstance @@ -596,8 +596,8 @@ const nevermined = await Nevermined.getInstance(config) #### Parameters -| Name | Type | -| :------- | :------------------------------------------ | +| Name | Type | +| :------ | :------ | | `config` | [`NeverminedOptions`](NeverminedOptions.md) | #### Returns @@ -606,9 +606,9 @@ const nevermined = await Nevermined.getInstance(config) #### Defined in -[src/nevermined/Nevermined.ts:102](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Nevermined.ts#L102) +[src/nevermined/Nevermined.ts:102](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Nevermined.ts#L102) ---- +___ ### setInstanceConfig @@ -616,15 +616,15 @@ const nevermined = await Nevermined.getInstance(config) #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -637,4 +637,4 @@ const nevermined = await Nevermined.getInstance(config) #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/NeverminedEvent.md b/docs/nevermined-sdk/api-reference/classes/NeverminedEvent.md index f35ec5d21e..a9d208f204 100644 --- a/docs/nevermined-sdk/api-reference/classes/NeverminedEvent.md +++ b/docs/nevermined-sdk/api-reference/classes/NeverminedEvent.md @@ -59,9 +59,9 @@ Initializes the NeverminedEvent instance #### Parameters -| Name | Type | Description | -| :------------- | :---------------------------------------------- | :---------------------------- | -| `contract` | [`ContractBase`](ContractBase.md) | contract instance | +| Name | Type | Description | +| :------ | :------ | :------ | +| `contract` | [`ContractBase`](ContractBase.md) | contract instance | | `eventEmitter` | [`EventEmitter`](../interfaces/EventEmitter.md) | events emitter implementation | #### Returns @@ -76,7 +76,7 @@ the NeverminedEvent instance #### Defined in -[src/events/NeverminedEvent.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/NeverminedEvent.ts#L26) +[src/events/NeverminedEvent.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/NeverminedEvent.ts#L26) ## Properties @@ -86,9 +86,9 @@ the NeverminedEvent instance #### Defined in -[src/events/NeverminedEvent.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/NeverminedEvent.ts#L15) +[src/events/NeverminedEvent.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/NeverminedEvent.ts#L15) ---- +___ ### eventEmitter @@ -96,7 +96,7 @@ the NeverminedEvent instance #### Defined in -[src/events/NeverminedEvent.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/NeverminedEvent.ts#L14) +[src/events/NeverminedEvent.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/NeverminedEvent.ts#L14) ## Accessors @@ -114,9 +114,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -132,9 +132,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -150,9 +150,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -168,9 +168,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -186,9 +186,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -204,9 +204,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -222,9 +222,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -240,9 +240,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -252,69 +252,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -322,9 +322,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -334,38 +334,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -373,7 +373,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -383,8 +383,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -393,9 +393,9 @@ Instantiable.walletClient #### Defined in -[src/events/NeverminedEvent.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/NeverminedEvent.ts#L18) +[src/events/NeverminedEvent.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/NeverminedEvent.ts#L18) ---- +___ ### getEventData @@ -403,8 +403,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :-------- | :---------------------------------------------- | +| Name | Type | +| :------ | :------ | | `options` | [`EventOptions`](../interfaces/EventOptions.md) | #### Returns @@ -413,9 +413,9 @@ Instantiable.walletClient #### Defined in -[src/events/NeverminedEvent.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/NeverminedEvent.ts#L16) +[src/events/NeverminedEvent.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/NeverminedEvent.ts#L16) ---- +___ ### getPastEvents @@ -423,8 +423,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :-------- | :---------------------------------------------- | +| Name | Type | +| :------ | :------ | | `options` | [`EventOptions`](../interfaces/EventOptions.md) | #### Returns @@ -433,9 +433,9 @@ Instantiable.walletClient #### Defined in -[src/events/NeverminedEvent.ts:17](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/NeverminedEvent.ts#L17) +[src/events/NeverminedEvent.ts:17](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/NeverminedEvent.ts#L17) ---- +___ ### once @@ -445,11 +445,11 @@ Subscribes to a contract event and waits for the first event to happen #### Parameters -| Name | Type | Default value | Description | -| :--------- | :------------------------------------------------------------------------ | :------------ | :------------------------------------------- | -| `callback` | (`events`: [`EventResult`](../code-reference.md#eventresult)[]) => `void` | `undefined` | function called when the event is triggered | -| `options` | [`EventOptions`](../interfaces/EventOptions.md) | `undefined` | event filter options | -| `timeout` | `number` | `15_000` | maximum time to wait for the event to happen | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `callback` | (`events`: [`EventResult`](../code-reference.md#eventresult)[]) => `void` | `undefined` | function called when the event is triggered | +| `options` | [`EventOptions`](../interfaces/EventOptions.md) | `undefined` | event filter options | +| `timeout` | `number` | `15_000` | maximum time to wait for the event to happen | #### Returns @@ -459,9 +459,9 @@ Promise with the event data #### Defined in -[src/events/NeverminedEvent.ts:60](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/NeverminedEvent.ts#L60) +[src/events/NeverminedEvent.ts:60](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/NeverminedEvent.ts#L60) ---- +___ ### setInstanceConfig @@ -469,8 +469,8 @@ Promise with the event data #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -483,9 +483,9 @@ Promise with the event data #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### subscribe @@ -495,10 +495,10 @@ Subscribes to a contract event #### Parameters -| Name | Type | Description | -| :--------- | :------------------------------------------------------------------------ | :------------------------------------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `callback` | (`events`: [`EventResult`](../code-reference.md#eventresult)[]) => `void` | function called when the event is triggered | -| `options` | [`EventOptions`](../interfaces/EventOptions.md) | event filter options | +| `options` | [`EventOptions`](../interfaces/EventOptions.md) | event filter options | #### Returns @@ -508,9 +508,9 @@ Subscribes to a contract event #### Defined in -[src/events/NeverminedEvent.ts:38](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/NeverminedEvent.ts#L38) +[src/events/NeverminedEvent.ts:38](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/NeverminedEvent.ts#L38) ---- +___ ### getInstance @@ -518,8 +518,8 @@ Subscribes to a contract event #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -532,9 +532,9 @@ Subscribes to a contract event #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -542,15 +542,15 @@ Subscribes to a contract event #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -563,4 +563,4 @@ Subscribes to a contract event #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/NeverminedNode.md b/docs/nevermined-sdk/api-reference/classes/NeverminedNode.md index ba0029a5f5..fe58c77ccd 100644 --- a/docs/nevermined-sdk/api-reference/classes/NeverminedNode.md +++ b/docs/nevermined-sdk/api-reference/classes/NeverminedNode.md @@ -82,8 +82,8 @@ The Nevermined Node is the technical component executed by the Publishers allowi #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -96,7 +96,7 @@ The Nevermined Node is the technical component executed by the Publishers allowi #### Defined in -[src/services/node/NeverminedNode.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L39) +[src/services/node/NeverminedNode.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L39) ## Accessors @@ -114,9 +114,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -132,9 +132,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -150,9 +150,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -168,9 +168,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -186,9 +186,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -204,9 +204,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -222,9 +222,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -240,9 +240,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -252,69 +252,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -322,9 +322,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### url @@ -336,9 +336,9 @@ Instantiable.publicClient #### Defined in -[src/services/node/NeverminedNode.ts:35](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L35) +[src/services/node/NeverminedNode.ts:35](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L35) ---- +___ ### walletClient @@ -348,38 +348,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -387,7 +387,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -397,15 +397,15 @@ Instantiable.walletClient #### Parameters -| Name | Type | Default value | -| :-------------- | :------------------------------- | :------------ | -| `agreementId` | `string` | `undefined` | -| `nftHolder` | `string` | `undefined` | -| `nftReceiver` | `string` | `undefined` | -| `nftAmount` | `bigint` | `undefined` | -| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | -| `did?` | `string` | `undefined` | -| `serviceIndex?` | `number` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | +| `nftHolder` | `string` | `undefined` | +| `nftReceiver` | `string` | `undefined` | +| `nftAmount` | `bigint` | `undefined` | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | +| `did?` | `string` | `undefined` | +| `serviceIndex?` | `number` | `undefined` | #### Returns @@ -413,9 +413,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:379](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L379) +[src/services/node/NeverminedNode.ts:379](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L379) ---- +___ ### computeLogs @@ -423,11 +423,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------------ | :---------------------------- | -| `agreementId` | `string` | -| `executionId` | `string` | -| `account` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `executionId` | `string` | +| `account` | [`NvmAccount`](NvmAccount.md) | #### Returns @@ -435,9 +435,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:309](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L309) +[src/services/node/NeverminedNode.ts:309](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L309) ---- +___ ### computeStatus @@ -445,11 +445,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------------ | :---------------------------- | -| `agreementId` | `string` | -| `executionId` | `string` | -| `account` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `executionId` | `string` | +| `account` | [`NvmAccount`](NvmAccount.md) | #### Returns @@ -457,9 +457,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:344](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L344) +[src/services/node/NeverminedNode.ts:344](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L344) ---- +___ ### consumeService @@ -467,18 +467,18 @@ Instantiable.walletClient #### Parameters -| Name | Type | Default value | -| :---------------- | :------------------------------------------------------------------------ | :----------------- | -| `did` | `string` | `undefined` | -| `agreementId` | `string` | `undefined` | -| `serviceEndpoint` | `string` | `undefined` | -| `account` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `files` | [`MetaDataExternalResource`](../interfaces/MetaDataExternalResource.md)[] | `undefined` | -| `destination` | `undefined` \| `string` | `undefined` | -| `index` | `number` | `-1` | -| `result` | [`AssetResult`](../enums/AssetResult.md) | `AssetResult.DATA` | -| `buyer?` | `string` | `undefined` | -| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `did` | `string` | `undefined` | +| `agreementId` | `string` | `undefined` | +| `serviceEndpoint` | `string` | `undefined` | +| `account` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `files` | [`MetaDataExternalResource`](../interfaces/MetaDataExternalResource.md)[] | `undefined` | +| `destination` | `undefined` \| `string` | `undefined` | +| `index` | `number` | `-1` | +| `result` | [`AssetResult`](../enums/AssetResult.md) | `AssetResult.DATA` | +| `buyer?` | `string` | `undefined` | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | #### Returns @@ -486,9 +486,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:173](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L173) +[src/services/node/NeverminedNode.ts:173](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L173) ---- +___ ### downloadService @@ -496,13 +496,13 @@ Instantiable.walletClient #### Parameters -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------------------ | :----------------- | -| `files` | [`MetaDataExternalResource`](../interfaces/MetaDataExternalResource.md)[] | `undefined` | -| `destination` | `undefined` \| `string` | `undefined` | -| `index` | `number` | `-1` | -| `headers?` | `Object` | `undefined` | -| `result` | [`AssetResult`](../enums/AssetResult.md) | `AssetResult.DATA` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `files` | [`MetaDataExternalResource`](../interfaces/MetaDataExternalResource.md)[] | `undefined` | +| `destination` | `undefined` \| `string` | `undefined` | +| `index` | `number` | `-1` | +| `headers?` | `Object` | `undefined` | +| `result` | [`AssetResult`](../enums/AssetResult.md) | `AssetResult.DATA` | #### Returns @@ -510,9 +510,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:240](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L240) +[src/services/node/NeverminedNode.ts:240](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L240) ---- +___ ### encrypt @@ -520,11 +520,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------- | :---- | -| `did` | `any` | +| Name | Type | +| :------ | :------ | +| `did` | `any` | | `document` | `any` | -| `method` | `any` | +| `method` | `any` | #### Returns @@ -532,9 +532,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:220](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L220) +[src/services/node/NeverminedNode.ts:220](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L220) ---- +___ ### execute @@ -542,11 +542,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------------ | :---------------------------- | -| `agreementId` | `string` | -| `workflowDid` | `string` | -| `account` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `workflowDid` | `string` | +| `account` | [`NvmAccount`](NvmAccount.md) | #### Returns @@ -554,9 +554,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:269](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L269) +[src/services/node/NeverminedNode.ts:269](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L269) ---- +___ ### fetchToken @@ -564,10 +564,10 @@ Instantiable.walletClient #### Parameters -| Name | Type | Default value | -| :------------ | :------- | :------------ | -| `grantToken` | `string` | `undefined` | -| `numberTries` | `number` | `3` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `grantToken` | `string` | `undefined` | +| `numberTries` | `number` | `3` | #### Returns @@ -575,9 +575,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:428](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L428) +[src/services/node/NeverminedNode.ts:428](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L428) ---- +___ ### getAccessEndpoint @@ -589,9 +589,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:56](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L56) +[src/services/node/NeverminedNode.ts:56](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L56) ---- +___ ### getAccessProofEndpoint @@ -603,9 +603,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:60](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L60) +[src/services/node/NeverminedNode.ts:60](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L60) ---- +___ ### getBabyjubPublicKey @@ -617,9 +617,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:139](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L139) +[src/services/node/NeverminedNode.ts:139](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L139) ---- +___ ### getClaimNftEndpoint @@ -631,9 +631,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:112](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L112) +[src/services/node/NeverminedNode.ts:112](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L112) ---- +___ ### getComputeLogsEndpoint @@ -641,8 +641,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `executionId` | `string` | #### Returns @@ -651,9 +651,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:68](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L68) +[src/services/node/NeverminedNode.ts:68](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L68) ---- +___ ### getComputeStatusEndpoint @@ -661,8 +661,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `executionId` | `string` | #### Returns @@ -671,9 +671,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:72](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L72) +[src/services/node/NeverminedNode.ts:72](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L72) ---- +___ ### getConsumeEndpoint @@ -685,9 +685,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L52) +[src/services/node/NeverminedNode.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L52) ---- +___ ### getDownloadEndpoint @@ -699,9 +699,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:144](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L144) +[src/services/node/NeverminedNode.ts:144](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L144) ---- +___ ### getEcdsaPublicKey @@ -713,9 +713,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:134](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L134) +[src/services/node/NeverminedNode.ts:134](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L134) ---- +___ ### getEncryptEndpoint @@ -727,9 +727,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:80](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L80) +[src/services/node/NeverminedNode.ts:80](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L80) ---- +___ ### getExecuteEndpoint @@ -737,8 +737,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------------------- | :------- | +| Name | Type | +| :------ | :------ | | `serviceAgreementId` | `string` | #### Returns @@ -747,9 +747,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L76) +[src/services/node/NeverminedNode.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L76) ---- +___ ### getFetchTokenEndpoint @@ -761,9 +761,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L84) +[src/services/node/NeverminedNode.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L84) ---- +___ ### getNeverminedNodeInfo @@ -775,9 +775,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:120](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L120) +[src/services/node/NeverminedNode.ts:120](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L120) ---- +___ ### getNft721Endpoint @@ -789,9 +789,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:104](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L104) +[src/services/node/NeverminedNode.ts:104](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L104) ---- +___ ### getNftAccessEndpoint @@ -803,9 +803,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L108) +[src/services/node/NeverminedNode.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L108) ---- +___ ### getNftEndpoint @@ -817,9 +817,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L100) +[src/services/node/NeverminedNode.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L100) ---- +___ ### getProviderAddress @@ -831,9 +831,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:124](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L124) +[src/services/node/NeverminedNode.ts:124](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L124) ---- +___ ### getPurchaseEndpoint @@ -845,9 +845,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L48) +[src/services/node/NeverminedNode.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L48) ---- +___ ### getRsaPublicKey @@ -859,9 +859,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:129](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L129) +[src/services/node/NeverminedNode.ts:129](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L129) ---- +___ ### getServiceEndpoint @@ -869,8 +869,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `service` | `string` | #### Returns @@ -879,9 +879,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:64](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L64) +[src/services/node/NeverminedNode.ts:64](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L64) ---- +___ ### getSubscriptionToken @@ -889,9 +889,9 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :-------- | :---------------------------- | -| `did` | `string` | +| Name | Type | +| :------ | :------ | +| `did` | `string` | | `account` | [`NvmAccount`](NvmAccount.md) | #### Returns @@ -900,9 +900,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:497](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L497) +[src/services/node/NeverminedNode.ts:497](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L497) ---- +___ ### getSubscriptionsEndpoint @@ -910,8 +910,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -920,9 +920,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:116](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L116) +[src/services/node/NeverminedNode.ts:116](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L116) ---- +___ ### getUploadFilecoinEndpoint @@ -934,9 +934,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:88](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L88) +[src/services/node/NeverminedNode.ts:88](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L88) ---- +___ ### getUploadIPFSEndpoint @@ -948,9 +948,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L92) +[src/services/node/NeverminedNode.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L92) ---- +___ ### getUploadS3Endpoint @@ -962,9 +962,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:96](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L96) +[src/services/node/NeverminedNode.ts:96](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L96) ---- +___ ### getVersionInfo @@ -976,9 +976,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L44) +[src/services/node/NeverminedNode.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L44) ---- +___ ### initializeServiceAgreement @@ -986,13 +986,13 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------------------- | :------- | -| `did` | `string` | +| Name | Type | +| :------ | :------ | +| `did` | `string` | | `serviceAgreementId` | `string` | -| `serviceIndex` | `number` | -| `signature` | `string` | -| `consumerAddress` | `string` | +| `serviceIndex` | `number` | +| `signature` | `string` | +| `consumerAddress` | `string` | #### Returns @@ -1000,30 +1000,30 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:148](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L148) +[src/services/node/NeverminedNode.ts:148](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L148) ---- +___ ### publishImmutableContent -▸ **publishImmutableContent**(`ddo`, `publishMetadata?`): `Promise`\<\{ `backend`: [`ImmutableBackends`](../enums/ImmutableBackends.md) ; `url`: `string` }\> +▸ **publishImmutableContent**(`ddo`, `publishMetadata?`): `Promise`\<\{ `backend`: [`ImmutableBackends`](../enums/ImmutableBackends.md) ; `url`: `string` }\> #### Parameters -| Name | Type | Default value | -| :---------------- | :------------------------------------------------------------- | :---------------------------- | -| `ddo` | [`DDO`](DDO.md) | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | `undefined` | | `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.IPFS` | #### Returns -`Promise`\<\{ `backend`: [`ImmutableBackends`](../enums/ImmutableBackends.md) ; `url`: `string` }\> +`Promise`\<\{ `backend`: [`ImmutableBackends`](../enums/ImmutableBackends.md) ; `url`: `string` }\> #### Defined in -[src/services/node/NeverminedNode.ts:443](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L443) +[src/services/node/NeverminedNode.ts:443](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L443) ---- +___ ### setInstanceConfig @@ -1031,8 +1031,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1045,9 +1045,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### uploadContent @@ -1055,11 +1055,11 @@ Instantiable.walletClient #### Parameters -| Name | Type | Default value | -| :--------- | :----------------------------------------------------- | :---------------------------- | -| `data` | `string` \| `ReadStream` | `undefined` | -| `encrypt?` | `boolean` | `undefined` | -| `backend` | [`NodeUploadBackends`](../enums/NodeUploadBackends.md) | `NodeUploadBackends.Filecoin` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `data` | `string` \| `ReadStream` | `undefined` | +| `encrypt?` | `boolean` | `undefined` | +| `backend` | [`NodeUploadBackends`](../enums/NodeUploadBackends.md) | `NodeUploadBackends.Filecoin` | #### Returns @@ -1067,9 +1067,9 @@ Instantiable.walletClient #### Defined in -[src/services/node/NeverminedNode.ts:469](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L469) +[src/services/node/NeverminedNode.ts:469](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L469) ---- +___ ### getInstance @@ -1077,8 +1077,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -1091,9 +1091,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -1101,15 +1101,15 @@ Instantiable.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1122,4 +1122,4 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/NeverminedNodeError.md b/docs/nevermined-sdk/api-reference/classes/NeverminedNodeError.md index 39ce6defba..e71461e42a 100644 --- a/docs/nevermined-sdk/api-reference/classes/NeverminedNodeError.md +++ b/docs/nevermined-sdk/api-reference/classes/NeverminedNodeError.md @@ -35,8 +35,8 @@ #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `message` | `string` | #### Returns @@ -49,7 +49,7 @@ Error.constructor #### Defined in -[src/errors/NeverminedErrors.ts:2](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/errors/NeverminedErrors.ts#L2) +[src/errors/NeverminedErrors.ts:2](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/errors/NeverminedErrors.ts#L2) ## Properties @@ -65,7 +65,7 @@ Error.cause node_modules/typescript/lib/lib.es2022.error.d.ts:24 ---- +___ ### message @@ -79,7 +79,7 @@ Error.message node_modules/typescript/lib/lib.es5.d.ts:1077 ---- +___ ### name @@ -93,7 +93,7 @@ Error.name node_modules/typescript/lib/lib.es5.d.ts:1076 ---- +___ ### stack @@ -107,7 +107,7 @@ Error.stack node_modules/typescript/lib/lib.es5.d.ts:1078 ---- +___ ### prepareStackTrace @@ -125,9 +125,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ##### Parameters -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | +| Name | Type | +| :------ | :------ | +| `err` | `Error` | | `stackTraces` | `CallSite`[] | ##### Returns @@ -142,7 +142,7 @@ Error.prepareStackTrace node_modules/@types/node/globals.d.ts:28 ---- +___ ### stackTraceLimit @@ -166,9 +166,9 @@ Create .stack property on a target object #### Parameters -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | | `constructorOpt?` | `Function` | #### Returns diff --git a/docs/nevermined-sdk/api-reference/classes/NeverminedOptions.md b/docs/nevermined-sdk/api-reference/classes/NeverminedOptions.md index 9a4e6a4c9b..b917729f97 100644 --- a/docs/nevermined-sdk/api-reference/classes/NeverminedOptions.md +++ b/docs/nevermined-sdk/api-reference/classes/NeverminedOptions.md @@ -48,9 +48,9 @@ #### Defined in -[src/models/NeverminedOptions.ts:73](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NeverminedOptions.ts#L73) +[src/models/NeverminedOptions.ts:73](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NeverminedOptions.ts#L73) ---- +___ ### appUrl @@ -60,9 +60,9 @@ The Nevermined App URL. #### Defined in -[src/models/NeverminedOptions.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NeverminedOptions.ts#L16) +[src/models/NeverminedOptions.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NeverminedOptions.ts#L16) ---- +___ ### artifactsFolder @@ -72,9 +72,9 @@ The folder where the nevermined contract artifacts are located. #### Defined in -[src/models/NeverminedOptions.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NeverminedOptions.ts#L67) +[src/models/NeverminedOptions.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NeverminedOptions.ts#L67) ---- +___ ### chainId @@ -82,9 +82,9 @@ The folder where the nevermined contract artifacts are located. #### Defined in -[src/models/NeverminedOptions.ts:5](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NeverminedOptions.ts#L5) +[src/models/NeverminedOptions.ts:5](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NeverminedOptions.ts#L5) ---- +___ ### circuitsFolder @@ -94,9 +94,9 @@ The folder where the nevermined contract circuits are located. #### Defined in -[src/models/NeverminedOptions.ts:71](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NeverminedOptions.ts#L71) +[src/models/NeverminedOptions.ts:71](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NeverminedOptions.ts#L71) ---- +___ ### gasMultiplier @@ -107,9 +107,9 @@ Can be used to speed up the transactions. #### Defined in -[src/models/NeverminedOptions.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NeverminedOptions.ts#L57) +[src/models/NeverminedOptions.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NeverminedOptions.ts#L57) ---- +___ ### gasStationUri @@ -119,9 +119,9 @@ Use a gas station to calculate transaction fees #### Defined in -[src/models/NeverminedOptions.ts:89](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NeverminedOptions.ts#L89) +[src/models/NeverminedOptions.ts:89](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NeverminedOptions.ts#L89) ---- +___ ### graphHttpUri @@ -131,9 +131,9 @@ Enpoint for the graph-node http query #### Defined in -[src/models/NeverminedOptions.ts:62](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NeverminedOptions.ts#L62) +[src/models/NeverminedOptions.ts:62](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NeverminedOptions.ts#L62) ---- +___ ### ipfsGateway @@ -145,9 +145,9 @@ the asset resolution requests. #### Defined in -[src/models/NeverminedOptions.ts:80](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NeverminedOptions.ts#L80) +[src/models/NeverminedOptions.ts:80](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NeverminedOptions.ts#L80) ---- +___ ### ipfsProjectId @@ -155,9 +155,9 @@ the asset resolution requests. #### Defined in -[src/models/NeverminedOptions.ts:82](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NeverminedOptions.ts#L82) +[src/models/NeverminedOptions.ts:82](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NeverminedOptions.ts#L82) ---- +___ ### ipfsProjectSecret @@ -165,9 +165,9 @@ the asset resolution requests. #### Defined in -[src/models/NeverminedOptions.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NeverminedOptions.ts#L84) +[src/models/NeverminedOptions.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NeverminedOptions.ts#L84) ---- +___ ### marketplaceAuthToken @@ -177,9 +177,9 @@ Marketplace auth token. #### Defined in -[src/models/NeverminedOptions.ts:41](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NeverminedOptions.ts#L41) +[src/models/NeverminedOptions.ts:41](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NeverminedOptions.ts#L41) ---- +___ ### marketplaceUri @@ -194,9 +194,9 @@ https://docs.nevermined.io/docs/architecture/marketplace-api/ #### Defined in -[src/models/NeverminedOptions.ts:23](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NeverminedOptions.ts#L23) +[src/models/NeverminedOptions.ts:23](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NeverminedOptions.ts#L23) ---- +___ ### neverminedNodeAddress @@ -210,9 +210,9 @@ The public address of the Nevermined Node. #### Defined in -[src/models/NeverminedOptions.ts:36](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NeverminedOptions.ts#L36) +[src/models/NeverminedOptions.ts:36](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NeverminedOptions.ts#L36) ---- +___ ### neverminedNodeUri @@ -227,9 +227,9 @@ https://docs.nevermined.io/docs/architecture/node/ #### Defined in -[src/models/NeverminedOptions.ts:30](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NeverminedOptions.ts#L30) +[src/models/NeverminedOptions.ts:30](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NeverminedOptions.ts#L30) ---- +___ ### verbose @@ -239,9 +239,9 @@ Log level. #### Defined in -[src/models/NeverminedOptions.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NeverminedOptions.ts#L51) +[src/models/NeverminedOptions.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NeverminedOptions.ts#L51) ---- +___ ### web3Provider @@ -251,9 +251,9 @@ Web3 Provider. #### Defined in -[src/models/NeverminedOptions.ts:46](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NeverminedOptions.ts#L46) +[src/models/NeverminedOptions.ts:46](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NeverminedOptions.ts#L46) ---- +___ ### web3ProviderUri @@ -265,9 +265,9 @@ It's possible to use a public available provider or a private/paid one like Infu #### Defined in -[src/models/NeverminedOptions.ts:11](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NeverminedOptions.ts#L11) +[src/models/NeverminedOptions.ts:11](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NeverminedOptions.ts#L11) ---- +___ ### zeroDevProjectId @@ -277,4 +277,4 @@ ZeroDev project id #### Defined in -[src/models/NeverminedOptions.ts:94](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NeverminedOptions.ts#L94) +[src/models/NeverminedOptions.ts:94](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NeverminedOptions.ts#L94) diff --git a/docs/nevermined-sdk/api-reference/classes/Nft1155Contract.md b/docs/nevermined-sdk/api-reference/classes/Nft1155Contract.md index 63e2bb060f..a7c8e5742c 100644 --- a/docs/nevermined-sdk/api-reference/classes/Nft1155Contract.md +++ b/docs/nevermined-sdk/api-reference/classes/Nft1155Contract.md @@ -75,8 +75,8 @@ NFTs contracts DTO allowing to manage Nevermined ERC-1155 NFTs #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -89,7 +89,7 @@ NFTs contracts DTO allowing to manage Nevermined ERC-1155 NFTs #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -103,9 +103,9 @@ NFTs contracts DTO allowing to manage Nevermined ERC-1155 NFTs #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -117,9 +117,9 @@ NFTs contracts DTO allowing to manage Nevermined ERC-1155 NFTs #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -131,9 +131,9 @@ NFTs contracts DTO allowing to manage Nevermined ERC-1155 NFTs #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -145,9 +145,9 @@ NFTs contracts DTO allowing to manage Nevermined ERC-1155 NFTs #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -159,7 +159,7 @@ NFTs contracts DTO allowing to manage Nevermined ERC-1155 NFTs #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -177,9 +177,9 @@ NFTContractsBase.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -195,9 +195,9 @@ NFTContractsBase.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -213,9 +213,9 @@ NFTContractsBase.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -231,9 +231,9 @@ NFTContractsBase.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -249,9 +249,9 @@ NFTContractsBase.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -267,9 +267,9 @@ NFTContractsBase.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -285,9 +285,9 @@ NFTContractsBase.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -303,9 +303,9 @@ NFTContractsBase.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -315,69 +315,69 @@ NFTContractsBase.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -385,9 +385,9 @@ NFTContractsBase.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -397,38 +397,38 @@ NFTContractsBase.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -436,28 +436,28 @@ NFTContractsBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods ### \_createClone -▸ **\_createClone**(`ercType`, `name`, `symbol`, `uri`, `cap`, `operators?`, `from`, `txParams?`): `Promise`\<`any`\> +▸ **_createClone**(`ercType`, `name`, `symbol`, `uri`, `cap`, `operators?`, `from`, `txParams?`): `Promise`\<`any`\> Creates a contract clone of an existing contract instance #### Parameters -| Name | Type | Default value | Description | -| :---------- | :---------------------------------------------- | :------------ | :------------------------------------------------------ | -| `ercType` | `721` \| `1155` | `undefined` | - | -| `name` | `string` | `undefined` | NFT Contract name | -| `symbol` | `string` | `undefined` | NFT Contract symbol | -| `uri` | `string` | `undefined` | NFT Contract metadata uri | -| `cap` | `undefined` \| `bigint` | `undefined` | NFT cap (just for ERC-721) | -| `operators` | `string`[] | `[]` | Array of account addresses to be added as NFT operators | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Sender account | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `ercType` | ``721`` \| ``1155`` | `undefined` | - | +| `name` | `string` | `undefined` | NFT Contract name | +| `symbol` | `string` | `undefined` | NFT Contract symbol | +| `uri` | `string` | `undefined` | NFT Contract metadata uri | +| `cap` | `undefined` \| `bigint` | `undefined` | NFT cap (just for ERC-721) | +| `operators` | `string`[] | `[]` | Array of account addresses to be added as NFT operators | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | #### Returns @@ -467,13 +467,13 @@ Contract Receipt #### Inherited from -[NFTContractsBase](NFTContractsBase.md).[\_createClone](NFTContractsBase.md#_createclone) +[NFTContractsBase](NFTContractsBase.md).[_createClone](NFTContractsBase.md#_createclone) #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L41) +[src/keeper/contracts/NFTContractsBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L41) ---- +___ ### balance @@ -483,10 +483,10 @@ Get an address balance for a specific NFT with id `did` #### Parameters -| Name | Type | Description | -| :-------- | :------- | :----------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `address` | `string` | Account address to check the balance | -| `did` | `string` | The NFT id | +| `did` | `string` | The NFT id | #### Returns @@ -494,9 +494,9 @@ Get an address balance for a specific NFT with id `did` #### Defined in -[src/keeper/contracts/Nft1155Contract.ts:120](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft1155Contract.ts#L120) +[src/keeper/contracts/Nft1155Contract.ts:120](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft1155Contract.ts#L120) ---- +___ ### burn @@ -506,11 +506,11 @@ It burns some editions of a NFT (ERC-1155) #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :-------------------------------- | -| `from` | [`NvmAccount`](NvmAccount.md) | Account burning the NFT editions | -| `tokenId` | `string` | The NFT id to burn | -| `amount` | `bigint` | Number of editions to burn | +| Name | Type | Description | +| :------ | :------ | :------ | +| `from` | [`NvmAccount`](NvmAccount.md) | Account burning the NFT editions | +| `tokenId` | `string` | The NFT id to burn | +| `amount` | `bigint` | Number of editions to burn | | `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | #### Returns @@ -521,9 +521,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/Nft1155Contract.ts:176](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft1155Contract.ts#L176) +[src/keeper/contracts/Nft1155Contract.ts:176](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft1155Contract.ts#L176) ---- +___ ### burnFromHolder @@ -533,13 +533,13 @@ It burns some editions of a NFT (ERC-1155) #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :-------------------------------------------------------------------------- | -| `holder` | `string` | Address of the account holding the NFT editions that are going to be burned | -| `tokenId` | `string` | The NFT id to burn | -| `amount` | `bigint` | Number of editions to burn | -| `from` | [`NvmAccount`](NvmAccount.md) | Account burning the NFT editions | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `holder` | `string` | Address of the account holding the NFT editions that are going to be burned | +| `tokenId` | `string` | The NFT id to burn | +| `amount` | `bigint` | Number of editions to burn | +| `from` | [`NvmAccount`](NvmAccount.md) | Account burning the NFT editions | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | #### Returns @@ -549,9 +549,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/Nft1155Contract.ts:195](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft1155Contract.ts#L195) +[src/keeper/contracts/Nft1155Contract.ts:195](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft1155Contract.ts#L195) ---- +___ ### call @@ -560,16 +560,16 @@ Contract Receipt #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -581,9 +581,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### createClone @@ -593,14 +593,14 @@ Creates a contract clone of an existing contract instance #### Parameters -| Name | Type | Default value | Description | -| :---------- | :---------------------------------------------- | :------------ | :------------------------------------------------------ | -| `name` | `string` | `undefined` | NFT Contract name | -| `symbol` | `string` | `undefined` | NFT Contract symbol | -| `uri` | `string` | `undefined` | NFT Contract metadata uri | -| `operators` | `string`[] | `[]` | Array of account addresses to be added as NFT operators | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Sender account | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `name` | `string` | `undefined` | NFT Contract name | +| `symbol` | `string` | `undefined` | NFT Contract symbol | +| `uri` | `string` | `undefined` | NFT Contract metadata uri | +| `operators` | `string`[] | `[]` | Array of account addresses to be added as NFT operators | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | #### Returns @@ -610,9 +610,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/Nft1155Contract.ts:73](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft1155Contract.ts#L73) +[src/keeper/contracts/Nft1155Contract.ts:73](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft1155Contract.ts#L73) ---- +___ ### getFromAddress @@ -620,8 +620,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -634,9 +634,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getMintedEntries @@ -646,10 +646,10 @@ It gets all the `NFT1155MintedEntry` events from the NFT Contract #### Parameters -| Name | Type | Description | -| :------ | :------- | :---------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `owner` | `string` | the user owning the NFT | -| `did?` | `string` | the tokenId of the NFT | +| `did?` | `string` | the tokenId of the NFT | #### Returns @@ -659,23 +659,23 @@ An array of `NFT1155MintedEntry` objects #### Defined in -[src/keeper/contracts/Nft1155Contract.ts:221](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft1155Contract.ts#L221) +[src/keeper/contracts/Nft1155Contract.ts:221](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft1155Contract.ts#L221) ---- +___ ### getNFTAttributes -▸ **getNFTAttributes**(`did`): `Promise`\<\{ `mintCap`: `bigint` ; `nftInitialized`: `boolean` ; `nftSupply`: `bigint` ; `nftURI`: `string` }\> +▸ **getNFTAttributes**(`did`): `Promise`\<\{ `mintCap`: `bigint` ; `nftInitialized`: `boolean` ; `nftSupply`: `bigint` ; `nftURI`: `string` }\> #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns -`Promise`\<\{ `mintCap`: `bigint` ; `nftInitialized`: `boolean` ; `nftSupply`: `bigint` ; `nftURI`: `string` }\> +`Promise`\<\{ `mintCap`: `bigint` ; `nftInitialized`: `boolean` ; `nftSupply`: `bigint` ; `nftURI`: `string` }\> #### Inherited from @@ -683,24 +683,24 @@ An array of `NFT1155MintedEntry` objects #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L97) +[src/keeper/contracts/NFTContractsBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L97) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -708,9 +708,9 @@ An array of `NFT1155MintedEntry` objects #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### grantOperatorRole @@ -720,11 +720,11 @@ Add an address as operator in the NFT Contract #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :----------------- | -| `operatorAddress` | `string` | New minter address | -| `from` | [`NvmAccount`](NvmAccount.md) | Sender account | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | New minter address | +| `from` | [`NvmAccount`](NvmAccount.md) | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | #### Returns @@ -738,9 +738,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L84) +[src/keeper/contracts/NFTContractsBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L84) ---- +___ ### init @@ -748,11 +748,11 @@ Contract Receipt #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -764,9 +764,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### isApprovedForAll @@ -776,9 +776,9 @@ Checks if the operator is approved for an account address #### Parameters -| Name | Type | Description | -| :---------------- | :------- | :--------------- | -| `accountAddress` | `string` | Account address | +| Name | Type | Description | +| :------ | :------ | :------ | +| `accountAddress` | `string` | Account address | | `operatorAddress` | `string` | Operator address | #### Returns @@ -789,9 +789,9 @@ Boolean #### Defined in -[src/keeper/contracts/Nft1155Contract.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft1155Contract.ts#L91) +[src/keeper/contracts/Nft1155Contract.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft1155Contract.ts#L91) ---- +___ ### isOperator @@ -801,8 +801,8 @@ Checks if an account is an operator in the NFT contract #### Parameters -| Name | Type | Description | -| :-------- | :------- | :----------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `address` | `string` | Account address to check if is an operator | #### Returns @@ -817,9 +817,9 @@ true if is an operator #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:93](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L93) +[src/keeper/contracts/NFTContractsBase.ts:93](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L93) ---- +___ ### mint @@ -829,14 +829,14 @@ It mints some editions of a NFT (ERC-1155) #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :---------------------------------- | -| `to` | `string` | Account address of the NFT receiver | -| `did` | `string` | The NFT id to mint | -| `amount` | `bigint` | Number of editions to mint | -| `from` | [`NvmAccount`](NvmAccount.md) | Account minting the NFT | -| `data?` | `string` | Data | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `to` | `string` | Account address of the NFT receiver | +| `did` | `string` | The NFT id to mint | +| `amount` | `bigint` | Number of editions to mint | +| `from` | [`NvmAccount`](NvmAccount.md) | Account minting the NFT | +| `data?` | `string` | Data | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | #### Returns @@ -846,9 +846,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/Nft1155Contract.ts:155](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft1155Contract.ts#L155) +[src/keeper/contracts/Nft1155Contract.ts:155](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft1155Contract.ts#L155) ---- +___ ### owner @@ -868,9 +868,9 @@ Address of the contract owner #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L26) +[src/keeper/contracts/NFTContractsBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L26) ---- +___ ### revokeOperatorRole @@ -880,11 +880,11 @@ Revoke an address as operator in the NFT Contract #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :----------------------- | -| `operatorAddress` | `string` | Minter address to revoke | -| `from` | [`NvmAccount`](NvmAccount.md) | Sender account | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | Minter address to revoke | +| `from` | [`NvmAccount`](NvmAccount.md) | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | #### Returns @@ -898,9 +898,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:130](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L130) +[src/keeper/contracts/NFTContractsBase.ts:130](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L130) ---- +___ ### send @@ -908,12 +908,12 @@ Contract Receipt #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -925,9 +925,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -935,12 +935,12 @@ Contract Receipt #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -952,9 +952,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setApprovalForAll @@ -964,12 +964,12 @@ Configure approval for a specific operator address #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :-------------------------------- | -| `operatorAddress` | `string` | Operator address | -| `approved` | `boolean` | Is approved | -| `from` | [`NvmAccount`](NvmAccount.md) | Sender account | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | Operator address | +| `approved` | `boolean` | Is approved | +| `from` | [`NvmAccount`](NvmAccount.md) | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | #### Returns @@ -979,9 +979,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/Nft1155Contract.ts:104](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft1155Contract.ts#L104) +[src/keeper/contracts/Nft1155Contract.ts:104](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft1155Contract.ts#L104) ---- +___ ### setInstanceConfig @@ -989,8 +989,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1003,9 +1003,9 @@ Contract Receipt #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1013,8 +1013,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1027,9 +1027,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### transferNft @@ -1039,13 +1039,13 @@ It transfers a NFT #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :----------------------------------------------- | -| `did` | `string` | The NFT id | -| `to` | `string` | Account address of the NFT receiver | -| `amount` | `bigint` | Number of editions to transfer. Typically just 1 | -| `from` | [`NvmAccount`](NvmAccount.md) | Account transferring the NFT | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The NFT id | +| `to` | `string` | Account address of the NFT receiver | +| `amount` | `bigint` | Number of editions to transfer. Typically just 1 | +| `from` | [`NvmAccount`](NvmAccount.md) | Account transferring the NFT | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | #### Returns @@ -1055,9 +1055,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/Nft1155Contract.ts:134](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft1155Contract.ts#L134) +[src/keeper/contracts/Nft1155Contract.ts:134](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft1155Contract.ts#L134) ---- +___ ### uri @@ -1067,9 +1067,9 @@ It returns the NFT metadata uri #### Parameters -| Name | Type | Description | -| :---- | :------- | :---------- | -| `did` | `string` | The NFT id | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The NFT id | #### Returns @@ -1079,9 +1079,9 @@ The NFT metadata url #### Defined in -[src/keeper/contracts/Nft1155Contract.ts:211](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft1155Contract.ts#L211) +[src/keeper/contracts/Nft1155Contract.ts:211](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft1155Contract.ts#L211) ---- +___ ### getInstance @@ -1089,12 +1089,12 @@ The NFT metadata url #### Parameters -| Name | Type | Default value | -| :---------------- | :---------------------------------------------------------- | :----------------------- | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `address?` | `string` | `undefined` | -| `contractName` | `string` | `'NFT1155Upgradeable'` | -| `artifactsFolder` | `undefined` \| `string` | `config.artifactsFolder` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `address?` | `string` | `undefined` | +| `contractName` | `string` | `'NFT1155Upgradeable'` | +| `artifactsFolder` | `undefined` \| `string` | `config.artifactsFolder` | #### Returns @@ -1106,9 +1106,9 @@ The NFT metadata url #### Defined in -[src/keeper/contracts/Nft1155Contract.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft1155Contract.ts#L15) +[src/keeper/contracts/Nft1155Contract.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft1155Contract.ts#L15) ---- +___ ### getInstanceUsingABI @@ -1116,11 +1116,11 @@ The NFT metadata url #### Parameters -| Name | Type | -| :------------ | :---------------------------------------------------------- | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | -| `address` | `string` | -| `solidityABI` | `any` | +| Name | Type | +| :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | +| `address` | `string` | +| `solidityABI` | `any` | #### Returns @@ -1128,9 +1128,9 @@ The NFT metadata url #### Defined in -[src/keeper/contracts/Nft1155Contract.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft1155Contract.ts#L44) +[src/keeper/contracts/Nft1155Contract.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft1155Contract.ts#L44) ---- +___ ### setInstanceConfig @@ -1138,15 +1138,15 @@ The NFT metadata url #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1159,4 +1159,4 @@ The NFT metadata url #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/Nft721.md b/docs/nevermined-sdk/api-reference/classes/Nft721.md deleted file mode 100644 index db424fdb3f..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/Nft721.md +++ /dev/null @@ -1,542 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / Nft721 - -# Class: Nft721 - -## Hierarchy - -- `Instantiable` - - ↳ **`Nft721`** - -## Table of contents - -### Constructors - -- [constructor](Nft721.md#constructor) - -### Properties - -- [contract](Nft721.md#contract) - -### Accessors - -- [address](Nft721.md#address) -- [artifactsFolder](Nft721.md#artifactsfolder) -- [config](Nft721.md#config) -- [instanceConfig](Nft721.md#instanceconfig) -- [instantiableConfig](Nft721.md#instantiableconfig) -- [logger](Nft721.md#logger) -- [nevermined](Nft721.md#nevermined) -- [web3](Nft721.md#web3) - -### Methods - -- [addresses](Nft721.md#addresses) -- [balanceOf](Nft721.md#balanceof) -- [checkExists](Nft721.md#checkexists) -- [findSigner](Nft721.md#findsigner) -- [isApprovedForAll](Nft721.md#isapprovedforall) -- [mint](Nft721.md#mint) -- [mintWithURL](Nft721.md#mintwithurl) -- [ownerOf](Nft721.md#ownerof) -- [setApprovalForAll](Nft721.md#setapprovalforall) -- [setInstanceConfig](Nft721.md#setinstanceconfig) -- [addressesStatic](Nft721.md#addressesstatic) -- [findSignerStatic](Nft721.md#findsignerstatic) -- [getInstance](Nft721.md#getinstance) -- [setInstanceConfig](Nft721.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new Nft721**() - -#### Inherited from - -Instantiable.constructor - -## Properties - -### contract - -• **contract**: `default` - -#### Defined in - -[src/nevermined/Nft721.ts:7](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nft721.ts#L7) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Defined in - -[src/nevermined/Nft721.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nft721.ts#L69) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -Instantiable.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -Instantiable.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Instantiable.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Instantiable.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -Instantiable.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -Instantiable.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -Instantiable.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addresses - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### balanceOf - -▸ **balanceOf**(`owner`): `Promise`<`default`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`Account`](Account.md) | - -#### Returns - -`Promise`<`default`\> - -#### Defined in - -[src/nevermined/Nft721.ts:61](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nft721.ts#L61) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -Instantiable.checkExists - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSigner - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### isApprovedForAll - -▸ **isApprovedForAll**(`accountAddress`, `operatorAddress`): `Promise`<`unknown`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountAddress` | `string` | -| `operatorAddress` | `string` | - -#### Returns - -`Promise`<`unknown`\> - -#### Defined in - -[src/nevermined/Nft721.ts:57](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nft721.ts#L57) - -___ - -### mint - -▸ **mint**(`did`, `publisher`, `txParams?`): `Promise`<`ContractReceipt`\> - -Mint NFTs associated with an asset. - -This function can be called multiple times as long as the minting does not exceed the maximum cap set during creation. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `publisher` | [`Account`](Account.md) | The account of the publisher of the NFT. | -| `txParams?` | `TxParameters` | - | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Defined in - -[src/nevermined/Nft721.ts:29](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nft721.ts#L29) - -___ - -### mintWithURL - -▸ **mintWithURL**(`to`, `did`, `url`, `from?`, `txParams?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `to` | `string` | -| `did` | `string` | -| `url` | `string` | -| `from?` | [`Account`](Account.md) | -| `txParams?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Defined in - -[src/nevermined/Nft721.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nft721.ts#L33) - -___ - -### ownerOf - -▸ **ownerOf**(`did`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/nevermined/Nft721.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nft721.ts#L65) - -___ - -### setApprovalForAll - -▸ **setApprovalForAll**(`target`, `state`, `publisher`, `txParams?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `target` | `string` | -| `state` | `boolean` | -| `publisher` | [`Account`](Account.md) | -| `txParams?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Defined in - -[src/nevermined/Nft721.ts:43](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nft721.ts#L43) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -Instantiable.setInstanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addressesStatic - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSignerStatic - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`, `address`): `Promise`<[`Nft721`](Nft721.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | -| `address` | `string` | - -#### Returns - -`Promise`<[`Nft721`](Nft721.md)\> - -#### Overrides - -Instantiable.getInstance - -#### Defined in - -[src/nevermined/Nft721.ts:9](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nft721.ts#L9) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -Instantiable.setInstanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/Nft721Contract.md b/docs/nevermined-sdk/api-reference/classes/Nft721Contract.md index de2b416261..7e98c353ec 100644 --- a/docs/nevermined-sdk/api-reference/classes/Nft721Contract.md +++ b/docs/nevermined-sdk/api-reference/classes/Nft721Contract.md @@ -73,8 +73,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -87,7 +87,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -101,9 +101,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -115,9 +115,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -129,9 +129,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -143,9 +143,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -157,7 +157,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -175,9 +175,9 @@ NFTContractsBase.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -193,9 +193,9 @@ NFTContractsBase.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -211,9 +211,9 @@ NFTContractsBase.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -229,9 +229,9 @@ NFTContractsBase.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -247,9 +247,9 @@ NFTContractsBase.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -265,9 +265,9 @@ NFTContractsBase.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -283,9 +283,9 @@ NFTContractsBase.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -301,9 +301,9 @@ NFTContractsBase.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -313,69 +313,69 @@ NFTContractsBase.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -383,9 +383,9 @@ NFTContractsBase.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -395,38 +395,38 @@ NFTContractsBase.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -434,28 +434,28 @@ NFTContractsBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods ### \_createClone -▸ **\_createClone**(`ercType`, `name`, `symbol`, `uri`, `cap`, `operators?`, `from`, `txParams?`): `Promise`\<`any`\> +▸ **_createClone**(`ercType`, `name`, `symbol`, `uri`, `cap`, `operators?`, `from`, `txParams?`): `Promise`\<`any`\> Creates a contract clone of an existing contract instance #### Parameters -| Name | Type | Default value | Description | -| :---------- | :---------------------------------------------- | :------------ | :------------------------------------------------------ | -| `ercType` | `721` \| `1155` | `undefined` | - | -| `name` | `string` | `undefined` | NFT Contract name | -| `symbol` | `string` | `undefined` | NFT Contract symbol | -| `uri` | `string` | `undefined` | NFT Contract metadata uri | -| `cap` | `undefined` \| `bigint` | `undefined` | NFT cap (just for ERC-721) | -| `operators` | `string`[] | `[]` | Array of account addresses to be added as NFT operators | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Sender account | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `ercType` | ``721`` \| ``1155`` | `undefined` | - | +| `name` | `string` | `undefined` | NFT Contract name | +| `symbol` | `string` | `undefined` | NFT Contract symbol | +| `uri` | `string` | `undefined` | NFT Contract metadata uri | +| `cap` | `undefined` \| `bigint` | `undefined` | NFT cap (just for ERC-721) | +| `operators` | `string`[] | `[]` | Array of account addresses to be added as NFT operators | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | #### Returns @@ -465,13 +465,13 @@ Contract Receipt #### Inherited from -[NFTContractsBase](NFTContractsBase.md).[\_createClone](NFTContractsBase.md#_createclone) +[NFTContractsBase](NFTContractsBase.md).[_createClone](NFTContractsBase.md#_createclone) #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L41) +[src/keeper/contracts/NFTContractsBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L41) ---- +___ ### balanceOf @@ -479,8 +479,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `owner` | `string` | #### Returns @@ -489,9 +489,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/Nft721Contract.ts:119](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft721Contract.ts#L119) +[src/keeper/contracts/Nft721Contract.ts:119](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft721Contract.ts#L119) ---- +___ ### burn @@ -501,10 +501,10 @@ It burns some editions of a NFT (ERC-721) #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :-------------------------------- | -| `tokenId` | `string` | The NFT id to burn | -| `from` | [`NvmAccount`](NvmAccount.md) | The account burning the NFT | +| Name | Type | Description | +| :------ | :------ | :------ | +| `tokenId` | `string` | The NFT id to burn | +| `from` | [`NvmAccount`](NvmAccount.md) | The account burning the NFT | | `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | #### Returns @@ -515,9 +515,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/Nft721Contract.ts:102](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft721Contract.ts#L102) +[src/keeper/contracts/Nft721Contract.ts:102](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft721Contract.ts#L102) ---- +___ ### call @@ -526,16 +526,16 @@ Contract Receipt #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -547,9 +547,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### createClone @@ -559,15 +559,15 @@ Creates a contract clone of an existing contract instance #### Parameters -| Name | Type | Default value | Description | -| :---------- | :---------------------------------------------- | :------------ | :------------------------------------------------------ | -| `name` | `string` | `undefined` | NFT Contract name | -| `symbol` | `string` | `undefined` | NFT Contract symbol | -| `uri` | `string` | `undefined` | NFT Contract metadata uri | -| `cap` | `bigint` | `undefined` | NFT cap | -| `operators` | `string`[] | `[]` | Array of account addresses to be added as NFT operators | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Sender account | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `name` | `string` | `undefined` | NFT Contract name | +| `symbol` | `string` | `undefined` | NFT Contract symbol | +| `uri` | `string` | `undefined` | NFT Contract metadata uri | +| `cap` | `bigint` | `undefined` | NFT cap | +| `operators` | `string`[] | `[]` | Array of account addresses to be added as NFT operators | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | #### Returns @@ -577,9 +577,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/Nft721Contract.ts:68](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft721Contract.ts#L68) +[src/keeper/contracts/Nft721Contract.ts:68](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft721Contract.ts#L68) ---- +___ ### getFromAddress @@ -587,8 +587,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -601,9 +601,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getMintedEntries @@ -613,10 +613,10 @@ It gets all the `NFT721MintedEntry` events from the NFT Contract #### Parameters -| Name | Type | Description | -| :------ | :------- | :---------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `owner` | `string` | the user owning the NFT | -| `did?` | `string` | the tokenId of the NFT | +| `did?` | `string` | the tokenId of the NFT | #### Returns @@ -626,23 +626,23 @@ An array of `NFT721MintedEntry` objects #### Defined in -[src/keeper/contracts/Nft721Contract.ts:137](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft721Contract.ts#L137) +[src/keeper/contracts/Nft721Contract.ts:137](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft721Contract.ts#L137) ---- +___ ### getNFTAttributes -▸ **getNFTAttributes**(`did`): `Promise`\<\{ `mintCap`: `bigint` ; `nftInitialized`: `boolean` ; `nftSupply`: `bigint` ; `nftURI`: `string` }\> +▸ **getNFTAttributes**(`did`): `Promise`\<\{ `mintCap`: `bigint` ; `nftInitialized`: `boolean` ; `nftSupply`: `bigint` ; `nftURI`: `string` }\> #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns -`Promise`\<\{ `mintCap`: `bigint` ; `nftInitialized`: `boolean` ; `nftSupply`: `bigint` ; `nftURI`: `string` }\> +`Promise`\<\{ `mintCap`: `bigint` ; `nftInitialized`: `boolean` ; `nftSupply`: `bigint` ; `nftURI`: `string` }\> #### Inherited from @@ -650,24 +650,24 @@ An array of `NFT721MintedEntry` objects #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L97) +[src/keeper/contracts/NFTContractsBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L97) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -675,9 +675,9 @@ An array of `NFT721MintedEntry` objects #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### grantOperatorRole @@ -687,11 +687,11 @@ Add an address as operator in the NFT Contract #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :----------------- | -| `operatorAddress` | `string` | New minter address | -| `from` | [`NvmAccount`](NvmAccount.md) | Sender account | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | New minter address | +| `from` | [`NvmAccount`](NvmAccount.md) | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | #### Returns @@ -705,9 +705,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L84) +[src/keeper/contracts/NFTContractsBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L84) ---- +___ ### init @@ -715,11 +715,11 @@ Contract Receipt #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -731,9 +731,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### isApprovedForAll @@ -741,9 +741,9 @@ Contract Receipt #### Parameters -| Name | Type | -| :---------------- | :------- | -| `accountAddress` | `string` | +| Name | Type | +| :------ | :------ | +| `accountAddress` | `string` | | `operatorAddress` | `string` | #### Returns @@ -752,9 +752,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/Nft721Contract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft721Contract.ts#L115) +[src/keeper/contracts/Nft721Contract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft721Contract.ts#L115) ---- +___ ### isOperator @@ -764,8 +764,8 @@ Checks if an account is an operator in the NFT contract #### Parameters -| Name | Type | Description | -| :-------- | :------- | :----------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `address` | `string` | Account address to check if is an operator | #### Returns @@ -780,9 +780,9 @@ true if is an operator #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:93](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L93) +[src/keeper/contracts/NFTContractsBase.ts:93](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L93) ---- +___ ### mint @@ -790,10 +790,10 @@ true if is an operator #### Parameters -| Name | Type | -| :---------- | :---------------------------------------------- | -| `did` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | | `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -802,9 +802,9 @@ true if is an operator #### Defined in -[src/keeper/contracts/Nft721Contract.ts:80](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft721Contract.ts#L80) +[src/keeper/contracts/Nft721Contract.ts:80](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft721Contract.ts#L80) ---- +___ ### mintWithURL @@ -812,12 +812,12 @@ true if is an operator #### Parameters -| Name | Type | -| :---------- | :---------------------------------------------- | -| `to` | `string` | -| `did` | `string` | -| `url` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `to` | `string` | +| `did` | `string` | +| `url` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | | `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -826,9 +826,9 @@ true if is an operator #### Defined in -[src/keeper/contracts/Nft721Contract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft721Contract.ts#L84) +[src/keeper/contracts/Nft721Contract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft721Contract.ts#L84) ---- +___ ### owner @@ -848,9 +848,9 @@ Address of the contract owner #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L26) +[src/keeper/contracts/NFTContractsBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L26) ---- +___ ### ownerOf @@ -858,8 +858,8 @@ Address of the contract owner #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -868,9 +868,9 @@ Address of the contract owner #### Defined in -[src/keeper/contracts/Nft721Contract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft721Contract.ts#L123) +[src/keeper/contracts/Nft721Contract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft721Contract.ts#L123) ---- +___ ### revokeOperatorRole @@ -880,11 +880,11 @@ Revoke an address as operator in the NFT Contract #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :----------------------- | -| `operatorAddress` | `string` | Minter address to revoke | -| `from` | [`NvmAccount`](NvmAccount.md) | Sender account | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | Minter address to revoke | +| `from` | [`NvmAccount`](NvmAccount.md) | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | #### Returns @@ -898,9 +898,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:130](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L130) +[src/keeper/contracts/NFTContractsBase.ts:130](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L130) ---- +___ ### send @@ -908,12 +908,12 @@ Contract Receipt #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -925,9 +925,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -935,12 +935,12 @@ Contract Receipt #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -952,9 +952,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setApprovalForAll @@ -962,11 +962,11 @@ Contract Receipt #### Parameters -| Name | Type | -| :---------- | :---------------------------------------------- | -| `target` | `string` | -| `state` | `boolean` | -| `from` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `target` | `string` | +| `state` | `boolean` | +| `from` | [`NvmAccount`](NvmAccount.md) | | `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -975,9 +975,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/Nft721Contract.ts:106](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft721Contract.ts#L106) +[src/keeper/contracts/Nft721Contract.ts:106](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft721Contract.ts#L106) ---- +___ ### setInstanceConfig @@ -985,8 +985,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -999,9 +999,9 @@ Contract Receipt #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1009,8 +1009,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1023,9 +1023,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### tokenURI @@ -1033,8 +1033,8 @@ Contract Receipt #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -1043,9 +1043,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/Nft721Contract.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft721Contract.ts#L127) +[src/keeper/contracts/Nft721Contract.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft721Contract.ts#L127) ---- +___ ### getInstance @@ -1053,12 +1053,12 @@ Contract Receipt #### Parameters -| Name | Type | Default value | -| :---------------- | :---------------------------------------------------------- | :----------------------- | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `address` | `string` | `undefined` | -| `contractName` | `string` | `'NFT721Upgradeable'` | -| `artifactsFolder` | `undefined` \| `string` | `config.artifactsFolder` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `address` | `string` | `undefined` | +| `contractName` | `string` | `'NFT721Upgradeable'` | +| `artifactsFolder` | `undefined` \| `string` | `config.artifactsFolder` | #### Returns @@ -1070,9 +1070,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/Nft721Contract.ts:12](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft721Contract.ts#L12) +[src/keeper/contracts/Nft721Contract.ts:12](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft721Contract.ts#L12) ---- +___ ### getInstanceUsingABI @@ -1080,11 +1080,11 @@ Contract Receipt #### Parameters -| Name | Type | -| :------------ | :---------------------------------------------------------- | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | -| `address` | `string` | -| `solidityABI` | `any` | +| Name | Type | +| :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | +| `address` | `string` | +| `solidityABI` | `any` | #### Returns @@ -1092,9 +1092,9 @@ Contract Receipt #### Defined in -[src/keeper/contracts/Nft721Contract.ts:38](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Nft721Contract.ts#L38) +[src/keeper/contracts/Nft721Contract.ts:38](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Nft721Contract.ts#L38) ---- +___ ### setInstanceConfig @@ -1102,15 +1102,15 @@ Contract Receipt #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1123,4 +1123,4 @@ Contract Receipt #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/Nfts.md b/docs/nevermined-sdk/api-reference/classes/Nfts.md deleted file mode 100644 index 3544b8eabc..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/Nfts.md +++ /dev/null @@ -1,1219 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / Nfts - -# Class: Nfts - -Nevermined Nft module - -## Hierarchy - -- `Instantiable` - - ↳ **`Nfts`** - -## Table of contents - -### Constructors - -- [constructor](Nfts.md#constructor) - -### Accessors - -- [artifactsFolder](Nfts.md#artifactsfolder) -- [config](Nfts.md#config) -- [instanceConfig](Nfts.md#instanceconfig) -- [instantiableConfig](Nfts.md#instantiableconfig) -- [logger](Nfts.md#logger) -- [nevermined](Nfts.md#nevermined) -- [web3](Nfts.md#web3) - -### Methods - -- [access](Nfts.md#access) -- [addresses](Nfts.md#addresses) -- [balance](Nfts.md#balance) -- [burn](Nfts.md#burn) -- [buySecondaryMarketNft](Nfts.md#buysecondarymarketnft) -- [checkExists](Nfts.md#checkexists) -- [create](Nfts.md#create) -- [create721](Nfts.md#create721) -- [createWithRoyalties](Nfts.md#createwithroyalties) -- [details](Nfts.md#details) -- [downloadFiles](Nfts.md#downloadfiles) -- [findSigner](Nfts.md#findsigner) -- [getNftContractAddress](Nfts.md#getnftcontractaddress) -- [listOnSecondaryMarkets](Nfts.md#listonsecondarymarkets) -- [mint](Nfts.md#mint) -- [order](Nfts.md#order) -- [order721](Nfts.md#order721) -- [ownerOf](Nfts.md#ownerof) -- [release721Rewards](Nfts.md#release721rewards) -- [releaseRewards](Nfts.md#releaserewards) -- [releaseSecondaryMarketRewards](Nfts.md#releasesecondarymarketrewards) -- [setApprovalForAll](Nfts.md#setapprovalforall) -- [setInstanceConfig](Nfts.md#setinstanceconfig) -- [transfer](Nfts.md#transfer) -- [transfer721](Nfts.md#transfer721) -- [transferForDelegate](Nfts.md#transferfordelegate) -- [addressesStatic](Nfts.md#addressesstatic) -- [findSignerStatic](Nfts.md#findsignerstatic) -- [getInstance](Nfts.md#getinstance) -- [setInstanceConfig](Nfts.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new Nfts**() - -#### Inherited from - -Instantiable.constructor - -## Accessors - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -Instantiable.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -Instantiable.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Instantiable.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Instantiable.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -Instantiable.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -Instantiable.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -Instantiable.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### access - -▸ **access**(`did`, `consumer`, `destination?`, `index?`, `agreementId?`): `Promise`<`boolean`\> - -Access the files associated with an NFT. - -**`Remarks`** - -This function will call the Node that will check if all the access conditions where fulfilled -before providing the files. - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | -| `consumer` | [`Account`](Account.md) | `undefined` | The NFT holder account. | -| `destination?` | `string` | `undefined` | The download destination for the files. | -| `index?` | `number` | `undefined` | - | -| `agreementId` | `string` | `'0x'` | - | - -#### Returns - -`Promise`<`boolean`\> - -true if the access was successful. - -#### Defined in - -[src/nevermined/Nfts.ts:618](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L618) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addresses - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### balance - -▸ **balance**(`did`, `account`): `Promise`<`default`\> - -Get the NFT balance for a particular did - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `account` | [`Account`](Account.md) | The account to check the balance of. | - -#### Returns - -`Promise`<`default`\> - -The amount of NFTs owned by the account. - -#### Defined in - -[src/nevermined/Nfts.ts:645](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L645) - -___ - -### burn - -▸ **burn**(`did`, `nftAmount`, `publisher`, `params?`): `Promise`<`ContractReceipt`\> - -Burn NFTs associated with an asset. - -**`Remarks`** - -The publisher can only burn NFTs that it owns. NFTs that were already transferred cannot be burned by the publisher. - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `nftAmount` | `default` | The amount of NFTs to burn. | -| `publisher` | [`Account`](Account.md) | The account of the publisher of the NFT. | -| `params?` | `TxParameters` | Optional transaction parameters. | - -#### Returns - -`Promise`<`ContractReceipt`\> - -The ethers.ContractReceipt - -#### Defined in - -[src/nevermined/Nfts.ts:256](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L256) - -___ - -### buySecondaryMarketNft - -▸ **buySecondaryMarketNft**(`consumer`, `nftAmount?`, `agreementIdSeed`, `params?`): `Promise`<`boolean`\> - -Buys a number of listed NFTs on secondary markets. - -**`Example`** - -```ts -// TODO -``` - -**`Throws`** - -NFTError -Thrown if there is an error buying the NFT. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `consumer` | [`Account`](Account.md) | The account of the buyer/consumer. | -| `nftAmount` | `default` | The number of assets to buy. 1 by default. | -| `agreementIdSeed` | `string` | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`boolean`\> - -true if the buy was successful. - -#### Defined in - -[src/nevermined/Nfts.ts:934](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L934) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -Instantiable.checkExists - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### create - -▸ **create**(`metadata`, `publisher`, `cap`, `royaltyAttributes`, `assetRewards`, `nftAmount?`, `erc20TokenAddress?`, `preMint?`, `nftMetadata?`, `appId?`, `txParams?`): [`SubscribablePromise`](utils.SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> - -Create a new NFT Nevermined NFT. - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | The metadata associated with the NFT. | -| `publisher` | [`Account`](Account.md) | The account of the creator od the NFT. | -| `cap` | `default` | The max number of nfts. | -| `royaltyAttributes` | `RoyaltyAttributes` | The royalties associated with the NFT. | -| `assetRewards` | `default` | The sales reward distribution. | -| `nftAmount` | `default` | The amount of NFTs that an address needs to hold in order to access the DID's protected assets. Leave it undefined and it will default to 1. | -| `erc20TokenAddress?` | `string` | The ERC-20 Token used to price the NFT. | -| `preMint?` | `boolean` | Set to true to mint _nftAmount_ during creation. | -| `nftMetadata?` | `string` | Url to the NFT metadata. | -| `appId?` | `string` | The id of the application creating the NFT. | -| `txParams?` | `TxParameters` | Optional transaction parameters | - -#### Returns - -[`SubscribablePromise`](utils.SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> - -The newly registered [DDO](DDO.md). - -#### Defined in - -[src/nevermined/Nfts.ts:64](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L64) - -___ - -### create721 - -▸ **create721**(`metadata`, `publisher`, `assetRewards`, `nftTokenAddress`, `erc20TokenAddress?`, `royaltyAttributes?`, `nftMetadata?`, `nftTransfer?`, `duration?`, `appId?`, `txParams?`): [`SubscribablePromise`](utils.SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> - -Create a new Nevermined NFT-721. - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | The metadata associated with the NFT. | -| `publisher` | [`Account`](Account.md) | `undefined` | The account of the creator od the NFT. | -| `assetRewards` | `default` | `undefined` | The sales reward distribution. | -| `nftTokenAddress` | `string` | `undefined` | The address of the ERC-721 contract | -| `erc20TokenAddress?` | `string` | `undefined` | The ERC-20 Token used to price the NFT. | -| `royaltyAttributes?` | `RoyaltyAttributes` | `undefined` | The royalties associated with the NFT. | -| `nftMetadata?` | `string` | `undefined` | Url to the NFT metadata. | -| `nftTransfer` | `boolean` | `true` | TODO | -| `duration` | `number` | `0` | TODO | -| `appId?` | `string` | `undefined` | Id of the application creating this NFT. | -| `txParams?` | `TxParameters` | `undefined` | Optional transaction parameters | - -#### Returns - -[`SubscribablePromise`](utils.SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> - -The newly registered [DDO](DDO.md). - -#### Defined in - -[src/nevermined/Nfts.ts:173](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L173) - -___ - -### createWithRoyalties - -▸ **createWithRoyalties**(`metadata`, `publisher`, `cap`, `royaltyAttributes`, `assetRewards`, `nftAmount?`, `erc20TokenAddress?`, `preMint?`, `nftMetadata?`, `nftType?`, `appId?`, `txParams?`): [`SubscribablePromise`](utils.SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> - -Create a new Nevermined NFT with royalties. - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | The metadata associated with the NFT. | -| `publisher` | [`Account`](Account.md) | `undefined` | The account of the creator od the NFT. | -| `cap` | `default` | `undefined` | The max number of nfts. | -| `royaltyAttributes` | `RoyaltyAttributes` | `undefined` | The royalties associated with the NFT. | -| `assetRewards` | `default` | `undefined` | The sales reward distribution. | -| `nftAmount` | `default` | `undefined` | The amount of NFTs that an address needs to hold in order to access the DID's protected assets. Leave it undefined and it will default to 1. | -| `erc20TokenAddress?` | `string` | `undefined` | The ERC-20 Token used to price the NFT. | -| `preMint?` | `boolean` | `undefined` | Set to true to mint _nftAmount_ during creation. | -| `nftMetadata?` | `string` | `undefined` | Url to the NFT metadata. | -| `nftType` | `NeverminedNFTType` | `NeverminedNFT1155Type.nft1155` | - | -| `appId?` | `string` | `undefined` | The id of the application creating the NFT. | -| `txParams?` | `TxParameters` | `undefined` | Optional transaction parameters | - -#### Returns - -[`SubscribablePromise`](utils.SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> - -The newly registered [DDO](DDO.md). - -#### Defined in - -[src/nevermined/Nfts.ts:119](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L119) - -___ - -### details - -▸ **details**(`did`): `Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `number` ; `nftSupply`: `number` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: `RoyaltyKind` ; `url`: `any` }\> - -Get the details of an NFT - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | - -#### Returns - -`Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `number` ; `nftSupply`: `number` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: `RoyaltyKind` ; `url`: `any` }\> - -The details of the NFT. - -#### Defined in - -[src/nevermined/Nfts.ts:693](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L693) - -___ - -### downloadFiles - -▸ `Private` **downloadFiles**(`agreementId`, `ddo`, `consumer`, `destination?`, `index?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `consumer` | [`Account`](Account.md) | -| `destination?` | `string` | -| `index?` | `number` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[src/nevermined/Nfts.ts:752](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L752) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSigner - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### getNftContractAddress - -▸ **getNftContractAddress**(`ddo`): `string` \| `number` \| `string`[] - -Get the NFT contract address associated with a Nevermined asset. - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ddo` | [`DDO`](DDO.md) | The DDO of the asset. | - -#### Returns - -`string` \| `number` \| `string`[] - -The NFT contract address. - -#### Defined in - -[src/nevermined/Nfts.ts:739](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L739) - -___ - -### listOnSecondaryMarkets - -▸ **listOnSecondaryMarkets**(`ddo`, `assetRewards`, `nftAmount`, `provider`, `token`, `owner`): `Promise`<`string`\> - -After purchase re-list an NFT to enable secondary market sales. - -**`Example`** - -```ts -// TODO -``` - -**`Throws`** - -NFTError -Thrown if there is an error listing the NFT. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ddo` | [`DDO`](DDO.md) | The DDO of the asset. | -| `assetRewards` | `default` | The current setup of asset rewards. | -| `nftAmount` | `default` | The number of NFTs put up for secondary sale. | -| `provider` | `string` | The address that will be the provider of the secondary sale. | -| `token` | `default` | - | -| `owner` | `string` | The account of the current owner. | - -#### Returns - -`Promise`<`string`\> - -the agreementId of the secondary sale. - -#### Defined in - -[src/nevermined/Nfts.ts:859](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L859) - -___ - -### mint - -▸ **mint**(`did`, `nftAmount`, `publisher`, `params?`): `Promise`<`ContractReceipt`\> - -Mint NFTs associated with an asset. - -**`Remarks`** - -This function can be called multiple times as long as the minting does not exceed the maximum cap set during creation. - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `nftAmount` | `default` | The amount of NFTs to mint. | -| `publisher` | [`Account`](Account.md) | The account of the publisher of the NFT. | -| `params?` | `TxParameters` | Optional transaction parameters. | - -#### Returns - -`Promise`<`ContractReceipt`\> - -The ethers.ContractReceipt - -#### Defined in - -[src/nevermined/Nfts.ts:224](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L224) - -___ - -### order - -▸ **order**(`did`, `nftAmount`, `consumer`, `txParams?`): [`SubscribablePromise`](utils.SubscribablePromise.md)<[`OrderProgressStep`](../enums/utils.OrderProgressStep.md), `string`\> - -Buy NFTs. - -**`Remarks`** - -This will lock the funds of the consumer in escrow pending the transfer of the NFTs -from the publisher. - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `nftAmount` | `default` | The amount of NFTs to buy. | -| `consumer` | [`Account`](Account.md) | The account of the NFT buyer. | -| `txParams?` | `TxParameters` | Optional transaction parameters. | - -#### Returns - -[`SubscribablePromise`](utils.SubscribablePromise.md)<[`OrderProgressStep`](../enums/utils.OrderProgressStep.md), `string`\> - -The agreement ID. - -#### Defined in - -[src/nevermined/Nfts.ts:291](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L291) - -___ - -### order721 - -▸ **order721**(`did`, `consumer`, `txParams?`): [`SubscribablePromise`](utils.SubscribablePromise.md)<[`OrderProgressStep`](../enums/utils.OrderProgressStep.md), `string`\> - -Buy NFT-721. - -**`Remarks`** - -This will lock the funds of the consumer in escrow pending the transfer of the NFTs -from the publisher. - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `consumer` | [`Account`](Account.md) | The account of the NFT buyer. | -| `txParams?` | `TxParameters` | Optional transaction parameters. | - -#### Returns - -[`SubscribablePromise`](utils.SubscribablePromise.md)<[`OrderProgressStep`](../enums/utils.OrderProgressStep.md), `string`\> - -The agreement ID. - -#### Defined in - -[src/nevermined/Nfts.ts:340](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L340) - -___ - -### ownerOf - -▸ **ownerOf**(`did`, `nftTokenAddress`, `agreementId?`): `Promise`<`string`\> - -Get the owner of the NFT - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | The Decentralized identifier of the NFT asset. | -| `nftTokenAddress` | `string` | The address of the ERC-721 contract. | -| `agreementId?` | `string` | The NFT sales agreement id. | - -#### Returns - -`Promise`<`string`\> - -The address of the NFT owner. - -#### Defined in - -[src/nevermined/Nfts.ts:663](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L663) - -___ - -### release721Rewards - -▸ **release721Rewards**(`agreementId`, `did`, `publisher`, `txParams?`): `Promise`<`boolean`\> - -Release the funds from escrow. - -**`Remarks`** - -A publisher is able to release the funds put on escrow by the consumer after transferring the NFTs. - -**`Example`** - -```ts -// TODO -``` - -**`Throws`** - -NFTError -Thrown if there is an error releasing the rewards. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | The NFT sales agreement id. | -| `did` | `string` | The Decentralized identifier of the NFT asset. | -| `publisher` | [`Account`](Account.md) | The current owner of the NFTs. | -| `txParams?` | `TxParameters` | Optional transaction parameters. | - -#### Returns - -`Promise`<`boolean`\> - -true if the funds release was successful. - -#### Defined in - -[src/nevermined/Nfts.ts:574](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L574) - -___ - -### releaseRewards - -▸ **releaseRewards**(`agreementId`, `did`, `nftAmount`, `publisher`, `txParams?`): `Promise`<`boolean`\> - -Release the funds from escrow. - -**`Remarks`** - -A publisher is able to release the funds put on escrow by the consumer after transferring the NFTs. - -**`Example`** - -```ts -// TODO -``` - -**`Throws`** - -NFTError -Thrown if there is an error releasing the rewards - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | The NFT sales agreement id. | -| `did` | `string` | The Decentralized identifier of the NFT asset. | -| `nftAmount` | `default` | The amount of NFTs to transfer. | -| `publisher` | [`Account`](Account.md) | The current owner of the NFTs. | -| `txParams?` | `TxParameters` | Optional transaction parameters. | - -#### Returns - -`Promise`<`boolean`\> - -true if the funds release was successful. - -#### Defined in - -[src/nevermined/Nfts.ts:526](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L526) - -___ - -### releaseSecondaryMarketRewards - -▸ **releaseSecondaryMarketRewards**(`owner`, `consumer`, `agreementIdSeed`, `params?`): `Promise`<`boolean`\> - -Used to release the secondary market NFT & the locked rewards. - -**`Example`** - -```ts -// TODO -``` - -**`Throws`** - -NFTError -Thrown if there is an error releasing the rewards. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `owner` | [`Account`](Account.md) | The owner account. | -| `consumer` | [`Account`](Account.md) | - | -| `agreementIdSeed` | `string` | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`boolean`\> - -true if the transaction was successful. - -#### Defined in - -[src/nevermined/Nfts.ts:997](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L997) - -___ - -### setApprovalForAll - -▸ **setApprovalForAll**(`operatorAddress`, `approved`, `from`): `Promise`<`ContractReceipt`\> - -Enable or disable NFT transfer rights for an operator. - -**`See`** - -[transferForDelegate](Nfts.md#transferfordelegate) - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `operatorAddress` | `string` | The address that of the operator we want to give transfer rights to. | -| `approved` | `boolean` | Give or remove transfer rights from the operator. | -| `from` | [`Account`](Account.md) | The account that wants to give transfer rights to the operator. | - -#### Returns - -`Promise`<`ContractReceipt`\> - -The ethers.ContractReceipt - -#### Defined in - -[src/nevermined/Nfts.ts:822](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L822) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -Instantiable.setInstanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### transfer - -▸ **transfer**(`agreementId`, `did`, `nftAmount`, `publisher`, `txParams?`): `Promise`<`boolean`\> - -Transfer NFTs to the consumer. - -**`Remarks`** - -A publisher/provider will check if the consumer put the funds in escrow and -execute the transfer in order to be able to release the rewards. - -**`Example`** - -```ts -// TODO -``` - -**`Throws`** - -NFTError -Thrown if there is an error transferring the NFT - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | The NFT sales agreement id. | -| `did` | `string` | The Decentralized identifier of the NFT asset. | -| `nftAmount` | `default` | The number of NFTs to transfer. | -| `publisher` | [`Account`](Account.md) | The current owner of the NFTs. | -| `txParams?` | `TxParameters` | Optional transaction parameters. | - -#### Returns - -`Promise`<`boolean`\> - -true if the transfer was successful. - -#### Defined in - -[src/nevermined/Nfts.ts:394](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L394) - -___ - -### transfer721 - -▸ **transfer721**(`agreementId`, `did`, `publisher`, `txParams?`): `Promise`<`boolean`\> - -Transfer NFT-721 to the consumer. - -**`Remarks`** - -A publisher/provider will check if the consumer put the funds in escrow and -execute the transfer in order to be able to release the rewards. - -**`Example`** - -```ts -// TODO -``` - -**`Throws`** - -NFTError -Thrown if there is an error transferring the NFT - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | The NFT sales agreement id. | -| `did` | `string` | The Decentralized identifier of the NFT asset. | -| `publisher` | [`Account`](Account.md) | The current owner of the NFTs. | -| `txParams?` | `TxParameters` | Optional transaction parameters. | - -#### Returns - -`Promise`<`boolean`\> - -true if the transfer was successful. - -#### Defined in - -[src/nevermined/Nfts.ts:481](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L481) - -___ - -### transferForDelegate - -▸ **transferForDelegate**(`agreementId`, `nftHolder`, `nftReceiver`, `nftAmount`, `ercType?`): `Promise`<`boolean`\> - -Asks the Node to transfer the NFT on behalf of the publisher. - -**`Remarks`** - -This is useful when the consumer does not want to wait for the publisher -to transfer the NFT once the payment is made. Assuming the publisher delegated -transfer permissions to the Node. - -One example would be a marketplace where the user wants to get access to the NFT -as soon as the payment is made - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | -| `nftHolder` | `string` | `undefined` | The address of the current owner of the NFT. | -| `nftReceiver` | `string` | `undefined` | The address where the NFT should be transferred. | -| `nftAmount` | `default` | `undefined` | The amount of NFTs to transfer. | -| `ercType` | `ERCType` | `1155` | The Type of the NFT ERC (1155 or 721). | - -#### Returns - -`Promise`<`boolean`\> - -true if the transfer was successful. - -#### Defined in - -[src/nevermined/Nfts.ts:443](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L443) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addressesStatic - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSignerStatic - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`Nfts`](Nfts.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`Nfts`](Nfts.md)\> - -#### Overrides - -Instantiable.getInstance - -#### Defined in - -[src/nevermined/Nfts.ts:36](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L36) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -Instantiable.setInstanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/NvmAccount.md b/docs/nevermined-sdk/api-reference/classes/NvmAccount.md index 398158e16f..8ce1ba5b15 100644 --- a/docs/nevermined-sdk/api-reference/classes/NvmAccount.md +++ b/docs/nevermined-sdk/api-reference/classes/NvmAccount.md @@ -49,9 +49,9 @@ Account information. #### Parameters -| Name | Type | -| :------------ | :--------------- | -| `id` | `string` | +| Name | Type | +| :------ | :------ | +| `id` | `string` | | `accountType` | `NvmAccountType` | #### Returns @@ -60,7 +60,7 @@ Account information. #### Defined in -[src/models/NvmAccount.ts:86](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L86) +[src/models/NvmAccount.ts:86](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L86) ## Properties @@ -70,9 +70,9 @@ Account information. #### Defined in -[src/models/NvmAccount.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L15) +[src/models/NvmAccount.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L15) ---- +___ ### accountType @@ -80,9 +80,9 @@ Account information. #### Defined in -[src/models/NvmAccount.ts:23](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L23) +[src/models/NvmAccount.ts:23](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L23) ---- +___ ### babySecret @@ -90,9 +90,9 @@ Account information. #### Defined in -[src/models/NvmAccount.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L14) +[src/models/NvmAccount.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L14) ---- +___ ### babyX @@ -100,9 +100,9 @@ Account information. #### Defined in -[src/models/NvmAccount.ts:12](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L12) +[src/models/NvmAccount.ts:12](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L12) ---- +___ ### babyY @@ -110,9 +110,9 @@ Account information. #### Defined in -[src/models/NvmAccount.ts:13](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L13) +[src/models/NvmAccount.ts:13](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L13) ---- +___ ### id @@ -120,19 +120,19 @@ Account information. #### Defined in -[src/models/NvmAccount.ts:87](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L87) +[src/models/NvmAccount.ts:87](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L87) ---- +___ ### kernelClient -• `Private` `Optional` **kernelClient**: `KernelAccountClient`\<`"0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789"`, `Transport`, `Chain`, `any`\> +• `Private` `Optional` **kernelClient**: `KernelAccountClient`\<``"0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789"``, `Transport`, `Chain`, `any`\> #### Defined in -[src/models/NvmAccount.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L16) +[src/models/NvmAccount.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L16) ---- +___ ### password @@ -140,9 +140,9 @@ Account information. #### Defined in -[src/models/NvmAccount.ts:11](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L11) +[src/models/NvmAccount.ts:11](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L11) ---- +___ ### zeroDevSigner @@ -150,7 +150,7 @@ Account information. #### Defined in -[src/models/NvmAccount.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L22) +[src/models/NvmAccount.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L22) ## Methods @@ -164,9 +164,9 @@ Account information. #### Defined in -[src/models/NvmAccount.ts:94](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L94) +[src/models/NvmAccount.ts:94](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L94) ---- +___ ### getAddress @@ -178,9 +178,9 @@ Account information. #### Defined in -[src/models/NvmAccount.ts:113](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L113) +[src/models/NvmAccount.ts:113](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L113) ---- +___ ### getId @@ -192,23 +192,23 @@ Account information. #### Defined in -[src/models/NvmAccount.ts:117](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L117) +[src/models/NvmAccount.ts:117](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L117) ---- +___ ### getKernelClient -▸ **getKernelClient**(): `undefined` \| `KernelAccountClient`\<`"0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789"`, `Transport`, `Chain`, `any`\> +▸ **getKernelClient**(): `undefined` \| `KernelAccountClient`\<``"0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789"``, `Transport`, `Chain`, `any`\> #### Returns -`undefined` \| `KernelAccountClient`\<`"0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789"`, `Transport`, `Chain`, `any`\> +`undefined` \| `KernelAccountClient`\<``"0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789"``, `Transport`, `Chain`, `any`\> #### Defined in -[src/models/NvmAccount.ts:98](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L98) +[src/models/NvmAccount.ts:98](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L98) ---- +___ ### getPassword @@ -224,9 +224,9 @@ The account password. #### Defined in -[src/models/NvmAccount.ts:153](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L153) +[src/models/NvmAccount.ts:153](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L153) ---- +___ ### getPublic @@ -238,23 +238,23 @@ The account password. #### Defined in -[src/models/NvmAccount.ts:125](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L125) +[src/models/NvmAccount.ts:125](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L125) ---- +___ ### getType -▸ **getType**(): `"local"` \| `"json-rpc"` \| `"zerodev"` \| `"sessionKey"` +▸ **getType**(): ``"local"`` \| ``"json-rpc"`` \| ``"zerodev"`` \| ``"sessionKey"`` #### Returns -`"local"` \| `"json-rpc"` \| `"zerodev"` \| `"sessionKey"` +``"local"`` \| ``"json-rpc"`` \| ``"zerodev"`` \| ``"sessionKey"`` #### Defined in -[src/models/NvmAccount.ts:102](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L102) +[src/models/NvmAccount.ts:102](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L102) ---- +___ ### getZeroDevSigner @@ -266,9 +266,9 @@ The account password. #### Defined in -[src/models/NvmAccount.ts:105](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L105) +[src/models/NvmAccount.ts:105](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L105) ---- +___ ### isZeroDev @@ -280,9 +280,9 @@ The account password. #### Defined in -[src/models/NvmAccount.ts:109](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L109) +[src/models/NvmAccount.ts:109](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L109) ---- +___ ### setId @@ -290,8 +290,8 @@ The account password. #### Parameters -| Name | Type | -| :--- | :------- | +| Name | Type | +| :------ | :------ | | `id` | `string` | #### Returns @@ -300,9 +300,9 @@ The account password. #### Defined in -[src/models/NvmAccount.ts:121](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L121) +[src/models/NvmAccount.ts:121](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L121) ---- +___ ### setPassword @@ -312,8 +312,8 @@ Set account password. #### Parameters -| Name | Type | Description | -| :--------- | :------- | :-------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `password` | `string` | Password for account. | #### Returns @@ -322,9 +322,9 @@ Set account password. #### Defined in -[src/models/NvmAccount.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L145) +[src/models/NvmAccount.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L145) ---- +___ ### signTextLocally @@ -332,8 +332,8 @@ Set account password. #### Parameters -| Name | Type | -| :----- | :----------------------- | +| Name | Type | +| :------ | :------ | | `text` | `string` \| `Uint8Array` | #### Returns @@ -342,9 +342,9 @@ Set account password. #### Defined in -[src/models/NvmAccount.ts:129](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L129) +[src/models/NvmAccount.ts:129](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L129) ---- +___ ### fromAccount @@ -354,8 +354,8 @@ Returns a nevermined Account from a viem account #### Parameters -| Name | Type | Description | -| :-------- | :------------------------------- | :------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `account` | `Account` \| `PrivateKeyAccount` | A viem local account | #### Returns @@ -366,9 +366,9 @@ The nevermined account #### Defined in -[src/models/NvmAccount.ts:31](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L31) +[src/models/NvmAccount.ts:31](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L31) ---- +___ ### fromAddress @@ -378,8 +378,8 @@ Returns a nevermined Account from an address. This method is used for browser in #### Parameters -| Name | Type | Description | -| :-------- | :--------------- | :--------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `address` | \`0x$\{string}\` | A wallet address | #### Returns @@ -390,9 +390,9 @@ The nevermined account #### Defined in -[src/models/NvmAccount.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L44) +[src/models/NvmAccount.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L44) ---- +___ ### fromZeroDevSessionKey @@ -400,9 +400,9 @@ The nevermined account #### Parameters -| Name | Type | -| :------------- | :--------------------------------------------------------------------------------------------------- | -| `kernelClient` | `KernelAccountClient`\<`"0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789"`, `Transport`, `Chain`, `any`\> | +| Name | Type | +| :------ | :------ | +| `kernelClient` | `KernelAccountClient`\<``"0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789"``, `Transport`, `Chain`, `any`\> | #### Returns @@ -410,9 +410,9 @@ The nevermined account #### Defined in -[src/models/NvmAccount.ts:71](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L71) +[src/models/NvmAccount.ts:71](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L71) ---- +___ ### fromZeroDevSigner @@ -422,9 +422,9 @@ Returns a nevermined Account from a zerodev signer #### Parameters -| Name | Type | -| :------------- | :--------------------------------------------------------------------------------------------------- | -| `kernelClient` | `KernelAccountClient`\<`"0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789"`, `Transport`, `Chain`, `any`\> | +| Name | Type | +| :------ | :------ | +| `kernelClient` | `KernelAccountClient`\<``"0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789"``, `Transport`, `Chain`, `any`\> | #### Returns @@ -434,4 +434,4 @@ The nevermined account #### Defined in -[src/models/NvmAccount.ts:56](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmAccount.ts#L56) +[src/models/NvmAccount.ts:56](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmAccount.ts#L56) diff --git a/docs/nevermined-sdk/api-reference/classes/NvmAccountError.md b/docs/nevermined-sdk/api-reference/classes/NvmAccountError.md index a2f988cc2e..658be50ff4 100644 --- a/docs/nevermined-sdk/api-reference/classes/NvmAccountError.md +++ b/docs/nevermined-sdk/api-reference/classes/NvmAccountError.md @@ -35,8 +35,8 @@ #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `message` | `string` | #### Returns @@ -49,7 +49,7 @@ Error.constructor #### Defined in -[src/errors/NeverminedErrors.ts:106](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/errors/NeverminedErrors.ts#L106) +[src/errors/NeverminedErrors.ts:106](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/errors/NeverminedErrors.ts#L106) ## Properties @@ -65,7 +65,7 @@ Error.cause node_modules/typescript/lib/lib.es2022.error.d.ts:24 ---- +___ ### message @@ -79,7 +79,7 @@ Error.message node_modules/typescript/lib/lib.es5.d.ts:1077 ---- +___ ### name @@ -93,7 +93,7 @@ Error.name node_modules/typescript/lib/lib.es5.d.ts:1076 ---- +___ ### stack @@ -107,7 +107,7 @@ Error.stack node_modules/typescript/lib/lib.es5.d.ts:1078 ---- +___ ### prepareStackTrace @@ -125,9 +125,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ##### Parameters -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | +| Name | Type | +| :------ | :------ | +| `err` | `Error` | | `stackTraces` | `CallSite`[] | ##### Returns @@ -142,7 +142,7 @@ Error.prepareStackTrace node_modules/@types/node/globals.d.ts:28 ---- +___ ### stackTraceLimit @@ -166,9 +166,9 @@ Create .stack property on a target object #### Parameters -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | | `constructorOpt?` | `Function` | #### Returns diff --git a/docs/nevermined-sdk/api-reference/classes/NvmApiKey.md b/docs/nevermined-sdk/api-reference/classes/NvmApiKey.md index f6a2ec4b83..10655c8ccb 100644 --- a/docs/nevermined-sdk/api-reference/classes/NvmApiKey.md +++ b/docs/nevermined-sdk/api-reference/classes/NvmApiKey.md @@ -55,7 +55,7 @@ Additional attributes #### Defined in -[src/models/NvmApiKey.ts:58](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L58) +[src/models/NvmApiKey.ts:58](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L58) ## Properties @@ -71,9 +71,9 @@ JWTPayload.aud #### Defined in -[src/models/NvmApiKey.ts:17](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L17) +[src/models/NvmApiKey.ts:17](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L17) ---- +___ ### exp @@ -91,9 +91,9 @@ JWTPayload.exp #### Defined in -[src/models/NvmApiKey.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L44) +[src/models/NvmApiKey.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L44) ---- +___ ### iat @@ -111,9 +111,9 @@ JWTPayload.iat #### Defined in -[src/models/NvmApiKey.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L51) +[src/models/NvmApiKey.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L51) ---- +___ ### iss @@ -127,9 +127,9 @@ JWTPayload.iss #### Defined in -[src/models/NvmApiKey.ts:12](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L12) +[src/models/NvmApiKey.ts:12](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L12) ---- +___ ### nvt @@ -139,9 +139,9 @@ The Marketplace auth token #### Defined in -[src/models/NvmApiKey.ts:37](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L37) +[src/models/NvmApiKey.ts:37](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L37) ---- +___ ### sub @@ -155,9 +155,9 @@ JWTPayload.sub #### Defined in -[src/models/NvmApiKey.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L22) +[src/models/NvmApiKey.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L22) ---- +___ ### ver @@ -167,9 +167,9 @@ The version of the key #### Defined in -[src/models/NvmApiKey.ts:27](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L27) +[src/models/NvmApiKey.ts:27](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L27) ---- +___ ### zsk @@ -179,7 +179,7 @@ The ZeroDev session key #### Defined in -[src/models/NvmApiKey.ts:32](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L32) +[src/models/NvmApiKey.ts:32](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L32) ## Methods @@ -193,9 +193,9 @@ The ZeroDev session key #### Defined in -[src/models/NvmApiKey.ts:164](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L164) +[src/models/NvmApiKey.ts:164](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L164) ---- +___ ### isValid @@ -203,9 +203,9 @@ The ZeroDev session key #### Parameters -| Name | Type | Default value | -| :-------- | :------- | :------------ | -| `chainId` | `number` | `0` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `chainId` | `number` | `0` | #### Returns @@ -213,9 +213,9 @@ The ZeroDev session key #### Defined in -[src/models/NvmApiKey.ts:126](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L126) +[src/models/NvmApiKey.ts:126](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L126) ---- +___ ### serialize @@ -227,9 +227,9 @@ The ZeroDev session key #### Defined in -[src/models/NvmApiKey.ts:152](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L152) +[src/models/NvmApiKey.ts:152](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L152) ---- +___ ### toString @@ -241,9 +241,9 @@ The ZeroDev session key #### Defined in -[src/models/NvmApiKey.ts:156](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L156) +[src/models/NvmApiKey.ts:156](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L156) ---- +___ ### decode @@ -251,8 +251,8 @@ The ZeroDev session key #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `str` | `string` | #### Returns @@ -261,9 +261,9 @@ The ZeroDev session key #### Defined in -[src/models/NvmApiKey.ts:160](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L160) +[src/models/NvmApiKey.ts:160](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L160) ---- +___ ### decryptAndDecode @@ -271,10 +271,10 @@ The ZeroDev session key #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `encryptedJwt` | `string` | -| `privateKey` | `string` | +| `privateKey` | `string` | #### Returns @@ -282,9 +282,9 @@ The ZeroDev session key #### Defined in -[src/models/NvmApiKey.ts:121](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L121) +[src/models/NvmApiKey.ts:121](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L121) ---- +___ ### deserialize @@ -292,8 +292,8 @@ The ZeroDev session key #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `str` | `string` | #### Returns @@ -302,9 +302,9 @@ The ZeroDev session key #### Defined in -[src/models/NvmApiKey.ts:148](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L148) +[src/models/NvmApiKey.ts:148](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L148) ---- +___ ### fromJWT @@ -312,8 +312,8 @@ The ZeroDev session key #### Parameters -| Name | Type | -| :---- | :----------- | +| Name | Type | +| :------ | :------ | | `jwt` | `JWTPayload` | #### Returns @@ -322,9 +322,9 @@ The ZeroDev session key #### Defined in -[src/models/NvmApiKey.ts:137](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L137) +[src/models/NvmApiKey.ts:137](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L137) ---- +___ ### generate @@ -332,16 +332,16 @@ The ZeroDev session key #### Parameters -| Name | Type | Default value | -| :--------------------- | :------------------------------------ | :------------ | -| `signatureUtils` | [`SignatureUtils`](SignatureUtils.md) | `undefined` | -| `issuerAccount` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `zeroDevSessionKey` | `string` | `undefined` | -| `marketplaceAuthToken` | `string` | `undefined` | -| `receiverAddress` | `string` | `undefined` | -| `expirationTime` | `string` | `'1y'` | -| `chainId` | `number` | `0` | -| `additionalParams` | `Object` | `{}` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `signatureUtils` | [`SignatureUtils`](SignatureUtils.md) | `undefined` | +| `issuerAccount` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `zeroDevSessionKey` | `string` | `undefined` | +| `marketplaceAuthToken` | `string` | `undefined` | +| `receiverAddress` | `string` | `undefined` | +| `expirationTime` | `string` | `'1y'` | +| `chainId` | `number` | `0` | +| `additionalParams` | `Object` | `{}` | #### Returns @@ -349,9 +349,9 @@ The ZeroDev session key #### Defined in -[src/models/NvmApiKey.ts:60](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L60) +[src/models/NvmApiKey.ts:60](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L60) ---- +___ ### generateEncrypted @@ -359,17 +359,17 @@ The ZeroDev session key #### Parameters -| Name | Type | Default value | -| :--------------------- | :------------------------------------ | :------------ | -| `signatureUtils` | [`SignatureUtils`](SignatureUtils.md) | `undefined` | -| `issuerAccount` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `zeroDevSessionKey` | `string` | `undefined` | -| `marketplaceAuthToken` | `string` | `undefined` | -| `receiverAddress` | `string` | `undefined` | -| `receiverPublicKey` | `string` | `undefined` | -| `expirationTime` | `string` | `'1y'` | -| `chainId` | `number` | `0` | -| `additionalParams` | `Object` | `{}` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `signatureUtils` | [`SignatureUtils`](SignatureUtils.md) | `undefined` | +| `issuerAccount` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `zeroDevSessionKey` | `string` | `undefined` | +| `marketplaceAuthToken` | `string` | `undefined` | +| `receiverAddress` | `string` | `undefined` | +| `receiverPublicKey` | `string` | `undefined` | +| `expirationTime` | `string` | `'1y'` | +| `chainId` | `number` | `0` | +| `additionalParams` | `Object` | `{}` | #### Returns @@ -377,9 +377,9 @@ The ZeroDev session key #### Defined in -[src/models/NvmApiKey.ts:97](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L97) +[src/models/NvmApiKey.ts:97](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L97) ---- +___ ### hash @@ -387,8 +387,8 @@ The ZeroDev session key #### Parameters -| Name | Type | -| :----------- | :------- | +| Name | Type | +| :------ | :------ | | `serialized` | `string` | #### Returns @@ -397,4 +397,4 @@ The ZeroDev session key #### Defined in -[src/models/NvmApiKey.ts:168](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/NvmApiKey.ts#L168) +[src/models/NvmApiKey.ts:168](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/NvmApiKey.ts#L168) diff --git a/docs/nevermined-sdk/api-reference/classes/NvmApp.md b/docs/nevermined-sdk/api-reference/classes/NvmApp.md index a910b3a70f..637ea03beb 100644 --- a/docs/nevermined-sdk/api-reference/classes/NvmApp.md +++ b/docs/nevermined-sdk/api-reference/classes/NvmApp.md @@ -74,8 +74,8 @@ Represents the NvmApp class. #### Parameters -| Name | Type | Description | -| :------- | :--------------------- | :------------------------------------------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `config` | `NeverminedAppOptions` | The configuration options for the Nevermined App. | #### Returns @@ -84,7 +84,7 @@ Represents the NvmApp class. #### Defined in -[src/nevermined/NvmApp.ts:125](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L125) +[src/nevermined/NvmApp.ts:125](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L125) ## Properties @@ -94,9 +94,9 @@ Represents the NvmApp class. #### Defined in -[src/nevermined/NvmApp.ts:74](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L74) +[src/nevermined/NvmApp.ts:74](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L74) ---- +___ ### configNVM @@ -104,9 +104,9 @@ Represents the NvmApp class. #### Defined in -[src/nevermined/NvmApp.ts:69](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L69) +[src/nevermined/NvmApp.ts:69](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L69) ---- +___ ### fullSDK @@ -114,9 +114,9 @@ Represents the NvmApp class. #### Defined in -[src/nevermined/NvmApp.ts:72](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L72) +[src/nevermined/NvmApp.ts:72](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L72) ---- +___ ### loginCredentials @@ -124,9 +124,9 @@ Represents the NvmApp class. #### Defined in -[src/nevermined/NvmApp.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L75) +[src/nevermined/NvmApp.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L75) ---- +___ ### networkFee @@ -134,9 +134,9 @@ Represents the NvmApp class. #### Defined in -[src/nevermined/NvmApp.ts:78](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L78) +[src/nevermined/NvmApp.ts:78](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L78) ---- +___ ### networkFeeReceiver @@ -144,9 +144,9 @@ Represents the NvmApp class. #### Defined in -[src/nevermined/NvmApp.ts:77](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L77) +[src/nevermined/NvmApp.ts:77](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L77) ---- +___ ### searchSDK @@ -154,9 +154,9 @@ Represents the NvmApp class. #### Defined in -[src/nevermined/NvmApp.ts:71](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L71) +[src/nevermined/NvmApp.ts:71](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L71) ---- +___ ### subscriptionNFTContractAddress @@ -164,9 +164,9 @@ Represents the NvmApp class. #### Defined in -[src/nevermined/NvmApp.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L76) +[src/nevermined/NvmApp.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L76) ---- +___ ### userAccount @@ -174,19 +174,19 @@ Represents the NvmApp class. #### Defined in -[src/nevermined/NvmApp.ts:70](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L70) +[src/nevermined/NvmApp.ts:70](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L70) ---- +___ ### zeroDevSignerAccount -• `Private` **zeroDevSignerAccount**: `undefined` \| `SmartAccountSigner`\<`"custom"`, \`0x$\{string}\`\> +• `Private` **zeroDevSignerAccount**: `undefined` \| `SmartAccountSigner`\<``"custom"``, \`0x$\{string}\`\> #### Defined in -[src/nevermined/NvmApp.ts:73](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L73) +[src/nevermined/NvmApp.ts:73](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L73) ---- +___ ### defaultAppInitializationOptions @@ -196,7 +196,7 @@ Default initialization options for the Nevermined application. #### Defined in -[src/nevermined/NvmApp.ts:83](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L83) +[src/nevermined/NvmApp.ts:83](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L83) ## Accessors @@ -214,9 +214,9 @@ The configuration options for the Nevermined application. #### Defined in -[src/nevermined/NvmApp.ts:246](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L246) +[src/nevermined/NvmApp.ts:246](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L246) ---- +___ ### networkFees @@ -230,16 +230,16 @@ Gets the network fees. An object containing the receiver and fee. -| Name | Type | -| :--------- | :------- | -| `fee` | `bigint` | +| Name | Type | +| :------ | :------ | +| `fee` | `bigint` | | `receiver` | `string` | #### Defined in -[src/nevermined/NvmApp.ts:281](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L281) +[src/nevermined/NvmApp.ts:281](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L281) ---- +___ ### sdk @@ -259,9 +259,9 @@ If Web3 is not connected, try calling the connect method first. #### Defined in -[src/nevermined/NvmApp.ts:271](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L271) +[src/nevermined/NvmApp.ts:271](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L271) ---- +___ ### search @@ -277,9 +277,9 @@ The SearchApi instance. #### Defined in -[src/nevermined/NvmApp.ts:254](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L254) +[src/nevermined/NvmApp.ts:254](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L254) ---- +___ ### services @@ -295,7 +295,7 @@ The Services API instance. #### Defined in -[src/nevermined/NvmApp.ts:262](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L262) +[src/nevermined/NvmApp.ts:262](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L262) ## Methods @@ -308,8 +308,8 @@ If the network fee is not already included in the price, it adjusts the price to #### Parameters -| Name | Type | Description | -| :------ | :---------------------------- | :------------------------------------------------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `price` | [`AssetPrice`](AssetPrice.md) | The asset price to which the network fee will be added. | #### Returns @@ -320,9 +320,9 @@ The updated asset price with the network fee included, or the original price if #### Defined in -[src/nevermined/NvmApp.ts:825](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L825) +[src/nevermined/NvmApp.ts:825](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L825) ---- +___ ### claimSubscription @@ -332,12 +332,12 @@ Claims a subscription by transferring the specified number of credits from the s #### Parameters -| Name | Type | Description | -| :---------------- | :------- | :----------------------------------------------------------- | -| `agreementId` | `string` | The ID of the agreement associated with the subscription. | -| `subscriptionDid` | `string` | The DID (Decentralized Identifier) of the subscription. | -| `numberCredits` | `bigint` | The number of credits to be claimed. | -| `serviceIndex?` | `number` | (Optional) The index of the service within the subscription. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | The ID of the agreement associated with the subscription. | +| `subscriptionDid` | `string` | The DID (Decentralized Identifier) of the subscription. | +| `numberCredits` | `bigint` | The number of credits to be claimed. | +| `serviceIndex?` | `number` | (Optional) The index of the service within the subscription. | #### Returns @@ -351,36 +351,36 @@ If Web3 is not connected or if there is an error claiming the NFT of the subscri #### Defined in -[src/nevermined/NvmApp.ts:564](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L564) +[src/nevermined/NvmApp.ts:564](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L564) ---- +___ ### connect -▸ **connect**(`account`, `message?`, `config?`, `initOptions?`): `Promise`\<\{ `marketplaceAuthToken`: `string` ; `userAccount`: [`NvmAccount`](NvmAccount.md) ; `zeroDevSignerAccount`: `undefined` \| `SmartAccountSigner`\<`"custom"`, \`0x$\{string}\`\> }\> +▸ **connect**(`account`, `message?`, `config?`, `initOptions?`): `Promise`\<\{ `marketplaceAuthToken`: `string` ; `userAccount`: [`NvmAccount`](NvmAccount.md) ; `zeroDevSignerAccount`: `undefined` \| `SmartAccountSigner`\<``"custom"``, \`0x$\{string}\`\> }\> Connects to the Nevermined network and initializes the NvmApp instance. #### Parameters -| Name | Type | Description | -| :------------- | :------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------- | -| `account` | `string` \| [`NvmAccount`](NvmAccount.md) \| `SmartAccountSigner`\<`"custom"`, \`0x$\{string}\`\> | The account to connect with. It can be either a string representing the account address or an instance of the Account class. | -| `message?` | `string` | An optional message to include in the client assertion for authentication. | -| `config?` | [`NeverminedOptions`](NeverminedOptions.md) | Optional configuration options for the Nevermined instance. | -| `initOptions?` | [`NeverminedInitializationOptions`](../interfaces/NeverminedInitializationOptions.md) | Optional initialization options for the Nevermined instance. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `string` \| [`NvmAccount`](NvmAccount.md) \| `SmartAccountSigner`\<``"custom"``, \`0x$\{string}\`\> | The account to connect with. It can be either a string representing the account address or an instance of the Account class. | +| `message?` | `string` | An optional message to include in the client assertion for authentication. | +| `config?` | [`NeverminedOptions`](NeverminedOptions.md) | Optional configuration options for the Nevermined instance. | +| `initOptions?` | [`NeverminedInitializationOptions`](../interfaces/NeverminedInitializationOptions.md) | Optional initialization options for the Nevermined instance. | #### Returns -`Promise`\<\{ `marketplaceAuthToken`: `string` ; `userAccount`: [`NvmAccount`](NvmAccount.md) ; `zeroDevSignerAccount`: `undefined` \| `SmartAccountSigner`\<`"custom"`, \`0x$\{string}\`\> }\> +`Promise`\<\{ `marketplaceAuthToken`: `string` ; `userAccount`: [`NvmAccount`](NvmAccount.md) ; `zeroDevSignerAccount`: `undefined` \| `SmartAccountSigner`\<``"custom"``, \`0x$\{string}\`\> }\> An object containing the marketplace authentication token, user account, and zeroDev signer account (if applicable). #### Defined in -[src/nevermined/NvmApp.ts:147](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L147) +[src/nevermined/NvmApp.ts:147](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L147) ---- +___ ### createCreditsSubscription @@ -390,11 +390,11 @@ Creates a credits subscription. #### Parameters -| Name | Type | Description | -| :--------------------- | :-------------------------------------- | :------------------------------------------ | -| `susbcriptionMetadata` | [`MetaData`](../interfaces/MetaData.md) | The metadata for the subscription. | -| `subscriptionPrice` | [`AssetPrice`](AssetPrice.md) | The price of the subscription. | -| `numberCredits` | `bigint` | The number of credits for the subscription. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `susbcriptionMetadata` | [`MetaData`](../interfaces/MetaData.md) | The metadata for the subscription. | +| `subscriptionPrice` | [`AssetPrice`](AssetPrice.md) | The price of the subscription. | +| `numberCredits` | `bigint` | The number of credits for the subscription. | #### Returns @@ -412,9 +412,9 @@ If the validation of the subscription fails. #### Defined in -[src/nevermined/NvmApp.ts:371](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L371) +[src/nevermined/NvmApp.ts:371](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L371) ---- +___ ### createCreditsSubscriptionAsync @@ -424,11 +424,11 @@ Creates a credits subscription asynchronously. #### Parameters -| Name | Type | Description | -| :--------------------- | :-------------------------------------- | :------------------------------------------ | -| `susbcriptionMetadata` | [`MetaData`](../interfaces/MetaData.md) | The metadata for the subscription. | -| `subscriptionPrice` | [`AssetPrice`](AssetPrice.md) | The price of the subscription. | -| `numberCredits` | `bigint` | The number of credits for the subscription. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `susbcriptionMetadata` | [`MetaData`](../interfaces/MetaData.md) | The metadata for the subscription. | +| `subscriptionPrice` | [`AssetPrice`](AssetPrice.md) | The price of the subscription. | +| `numberCredits` | `bigint` | The number of credits for the subscription. | #### Returns @@ -438,9 +438,9 @@ A Promise that resolves to a DDO (Decentralized Data Object). #### Defined in -[src/nevermined/NvmApp.ts:425](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L425) +[src/nevermined/NvmApp.ts:425](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L425) ---- +___ ### createTimeSubscription @@ -450,11 +450,11 @@ Creates a time-based subscription for a given asset. #### Parameters -| Name | Type | Description | -| :--------------------- | :-------------------------------------- | :------------------------------------------- | -| `susbcriptionMetadata` | [`MetaData`](../interfaces/MetaData.md) | The metadata of the subscription. | -| `subscriptionPrice` | [`AssetPrice`](AssetPrice.md) | The price of the subscription. | -| `duration` | `number` | The duration of the subscription in seconds. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `susbcriptionMetadata` | [`MetaData`](../interfaces/MetaData.md) | The metadata of the subscription. | +| `subscriptionPrice` | [`AssetPrice`](AssetPrice.md) | The price of the subscription. | +| `duration` | `number` | The duration of the subscription in seconds. | #### Returns @@ -472,9 +472,9 @@ If the validation of the subscription fails. #### Defined in -[src/nevermined/NvmApp.ts:297](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L297) +[src/nevermined/NvmApp.ts:297](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L297) ---- +___ ### createTimeSubscriptionAsync @@ -484,11 +484,11 @@ Creates a time-based subscription asynchronously. #### Parameters -| Name | Type | Description | -| :--------------------- | :-------------------------------------- | :------------------------------------------- | -| `susbcriptionMetadata` | [`MetaData`](../interfaces/MetaData.md) | The metadata for the subscription. | -| `subscriptionPrice` | [`AssetPrice`](AssetPrice.md) | The price of the subscription. | -| `duration` | `number` | The duration of the subscription in seconds. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `susbcriptionMetadata` | [`MetaData`](../interfaces/MetaData.md) | The metadata for the subscription. | +| `subscriptionPrice` | [`AssetPrice`](AssetPrice.md) | The price of the subscription. | +| `duration` | `number` | The duration of the subscription in seconds. | #### Returns @@ -498,9 +498,9 @@ A Promise that resolves to the [DDO](DDO.md) (Decentralized Data Object) of the #### Defined in -[src/nevermined/NvmApp.ts:353](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L353) +[src/nevermined/NvmApp.ts:353](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L353) ---- +___ ### disconnect @@ -515,9 +515,9 @@ Clears the fullSDK instance and resets the user account, zeroDevSigner settings, #### Defined in -[src/nevermined/NvmApp.ts:216](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L216) +[src/nevermined/NvmApp.ts:216](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L216) ---- +___ ### downloadFiles @@ -527,12 +527,12 @@ Downloads files associated with a given file asset DID. #### Parameters -| Name | Type | Description | -| :----------------- | :------- | :-------------------------------------------------------------------------------------- | -| `fileAssetDid` | `string` | The DID of the file asset. | -| `fileIndex?` | `number` | (Optional) The index of the file to download if the file asset contains multiple files. | -| `destinationPath?` | `string` | (Optional) The path where the downloaded files will be saved. | -| `agreementId?` | `string` | (Optional) The ID of the agreement associated with the file asset. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `fileAssetDid` | `string` | The DID of the file asset. | +| `fileIndex?` | `number` | (Optional) The index of the file to download if the file asset contains multiple files. | +| `destinationPath?` | `string` | (Optional) The path where the downloaded files will be saved. | +| `agreementId?` | `string` | (Optional) The ID of the agreement associated with the file asset. | #### Returns @@ -546,9 +546,9 @@ If there is an error downloading the files. #### Defined in -[src/nevermined/NvmApp.ts:652](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L652) +[src/nevermined/NvmApp.ts:652](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L652) ---- +___ ### getBalance @@ -559,9 +559,9 @@ If no account address is provided, the user's account ID will be used. #### Parameters -| Name | Type | Description | -| :---------------- | :------- | :--------------------------------------------------------------------------------------------------- | -| `subscriptionDid` | `string` | The DID (Decentralized Identifier) of the subscription. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `subscriptionDid` | `string` | The DID (Decentralized Identifier) of the subscription. | | `accountAddress?` | `string` | (Optional) The Ethereum address of the account. If not provided, the user's account ID will be used. | #### Returns @@ -580,9 +580,9 @@ If there is an error retrieving the subscription information. #### Defined in -[src/nevermined/NvmApp.ts:599](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L599) +[src/nevermined/NvmApp.ts:599](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L599) ---- +___ ### getLoginCredentials @@ -598,9 +598,9 @@ The login credentials as a string, or undefined if not set. #### Defined in -[src/nevermined/NvmApp.ts:238](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L238) +[src/nevermined/NvmApp.ts:238](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L238) ---- +___ ### getServiceAccessToken @@ -610,8 +610,8 @@ Retrieves the service access token for a given service DID. #### Parameters -| Name | Type | Description | -| :----------- | :------- | :------------------------------------------------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `serviceDid` | `string` | The service DID for which to retrieve the access token. | #### Returns @@ -626,9 +626,9 @@ If Web3 is not connected. Call the connect method first. #### Defined in -[src/nevermined/NvmApp.ts:635](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L635) +[src/nevermined/NvmApp.ts:635](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L635) ---- +___ ### initializeSearch @@ -638,8 +638,8 @@ Initializes the search functionality of the Nevermined App. #### Parameters -| Name | Type | Description | -| :-------- | :--------------------- | :----------------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `config?` | `NeverminedAppOptions` | Optional configuration options for the Nevermined App. | #### Returns @@ -650,9 +650,9 @@ A Promise that resolves to void. #### Defined in -[src/nevermined/NvmApp.ts:134](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L134) +[src/nevermined/NvmApp.ts:134](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L134) ---- +___ ### isNetworkFeeIncluded @@ -662,8 +662,8 @@ Checks if the network fee is included in the given asset price. #### Parameters -| Name | Type | Description | -| :------ | :---------------------------- | :------------------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `price` | [`AssetPrice`](AssetPrice.md) | The asset price to check. | #### Returns @@ -674,9 +674,9 @@ A boolean indicating whether the network fee is included. #### Defined in -[src/nevermined/NvmApp.ts:840](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L840) +[src/nevermined/NvmApp.ts:840](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L840) ---- +___ ### isWeb3Connected @@ -692,9 +692,9 @@ True if the web3 provider is connected, false otherwise. #### Defined in -[src/nevermined/NvmApp.ts:230](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L230) +[src/nevermined/NvmApp.ts:230](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L230) ---- +___ ### orderSubscription @@ -704,11 +704,11 @@ Orders a subscription for a given NFT. #### Parameters -| Name | Type | Description | -| :---------------- | :------- | :------------------------------------------------------------------- | -| `subscriptionDid` | `string` | The DID of the subscription NFT. | -| `numberCredits` | `bigint` | The number of credits to be used for the subscription. | -| `serviceIndex?` | `number` | (Optional) The index of the service to be used for the subscription. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `subscriptionDid` | `string` | The DID of the subscription NFT. | +| `numberCredits` | `bigint` | The number of credits to be used for the subscription. | +| `serviceIndex?` | `number` | (Optional) The index of the service to be used for the subscription. | #### Returns @@ -726,9 +726,9 @@ If there is an error ordering the subscription. #### Defined in -[src/nevermined/NvmApp.ts:534](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L534) +[src/nevermined/NvmApp.ts:534](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L534) ---- +___ ### orderSubscriptionAsync @@ -738,10 +738,10 @@ Orders a subscription and claim asynchronously. #### Parameters -| Name | Type | Description | -| :---------------- | :------- | :---------------------------------- | -| `subscriptionDid` | `string` | The DID of the subscription. | -| `agreementId?` | `string` | The ID of the agreement (optional). | +| Name | Type | Description | +| :------ | :------ | :------ | +| `subscriptionDid` | `string` | The DID of the subscription. | +| `agreementId?` | `string` | The ID of the agreement (optional). | #### Returns @@ -759,9 +759,9 @@ If there is an error ordering the subscription. #### Defined in -[src/nevermined/NvmApp.ts:480](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L480) +[src/nevermined/NvmApp.ts:480](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L480) ---- +___ ### registerFileAsset @@ -771,11 +771,11 @@ Registers a file asset by creating a new DDO (Decentralized Data Object) on the #### Parameters -| Name | Type | Description | -| :---------------- | :-------------------------------------- | :------------------------------------------------------------------------------ | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | The metadata of the file asset. | -| `subscriptionDid` | `string` | The subscription DID (Decentralized Identifier) associated with the file asset. | -| `costInCredits` | `bigint` | The cost of the file asset in credits (default is 1). | +| Name | Type | Description | +| :------ | :------ | :------ | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | The metadata of the file asset. | +| `subscriptionDid` | `string` | The subscription DID (Decentralized Identifier) associated with the file asset. | +| `costInCredits` | `bigint` | The cost of the file asset in credits (default is 1). | #### Returns @@ -793,9 +793,9 @@ If the file asset metadata is not valid. #### Defined in -[src/nevermined/NvmApp.ts:760](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L760) +[src/nevermined/NvmApp.ts:760](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L760) ---- +___ ### registerFileAssetAsync @@ -805,11 +805,11 @@ Registers a file asset asynchronously. #### Parameters -| Name | Type | Description | -| :---------------- | :-------------------------------------- | :--------------------------------- | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | The metadata of the file asset. | -| `subscriptionDid` | `string` | The subscription DID. | -| `costInCredits` | `bigint` | The cost in credits (default: 1n). | +| Name | Type | Description | +| :------ | :------ | :------ | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | The metadata of the file asset. | +| `subscriptionDid` | `string` | The subscription DID. | +| `costInCredits` | `bigint` | The cost in credits (default: 1n). | #### Returns @@ -819,9 +819,9 @@ A Promise that resolves to the registered DDO (Decentralized Data Object). #### Defined in -[src/nevermined/NvmApp.ts:810](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L810) +[src/nevermined/NvmApp.ts:810](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L810) ---- +___ ### registerServiceAsset @@ -831,13 +831,13 @@ Registers a service asset. #### Parameters -| Name | Type | Description | -| :------------------- | :-------------------------------------- | :--------------------------------------------------- | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | The metadata of the asset. | -| `subscriptionDid` | `string` | The subscription DID. | -| `costInCredits` | `bigint` | The cost in credits (default: 1). | -| `minCreditsToCharge` | `bigint` | The minimum credits required to charge (default: 1). | -| `maxCreditsToCharge` | `bigint` | The maximum credits to charge (default: 1). | +| Name | Type | Description | +| :------ | :------ | :------ | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | The metadata of the asset. | +| `subscriptionDid` | `string` | The subscription DID. | +| `costInCredits` | `bigint` | The cost in credits (default: 1). | +| `minCreditsToCharge` | `bigint` | The minimum credits required to charge (default: 1). | +| `maxCreditsToCharge` | `bigint` | The maximum credits to charge (default: 1). | #### Returns @@ -855,9 +855,9 @@ If the metadata validation fails. #### Defined in -[src/nevermined/NvmApp.ts:687](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L687) +[src/nevermined/NvmApp.ts:687](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L687) ---- +___ ### registerServiceAssetAsync @@ -865,13 +865,13 @@ If the metadata validation fails. #### Parameters -| Name | Type | -| :------------------- | :-------------------------------------- | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | -| `subscriptionDid` | `string` | -| `costInCredits` | `bigint` | -| `minCreditsToCharge` | `bigint` | -| `maxCreditsToCharge` | `bigint` | +| Name | Type | +| :------ | :------ | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `subscriptionDid` | `string` | +| `costInCredits` | `bigint` | +| `minCreditsToCharge` | `bigint` | +| `maxCreditsToCharge` | `bigint` | #### Returns @@ -879,9 +879,9 @@ If the metadata validation fails. #### Defined in -[src/nevermined/NvmApp.ts:734](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L734) +[src/nevermined/NvmApp.ts:734](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L734) ---- +___ ### updateAsset @@ -891,10 +891,10 @@ Updates the metadata of an asset. #### Parameters -| Name | Type | Description | -| :--------- | :-------------------------------------- | :----------------------------------------------- | -| `did` | `string` | The decentralized identifier (DID) of the asset. | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | The updated metadata for the asset. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The decentralized identifier (DID) of the asset. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | The updated metadata for the asset. | #### Returns @@ -908,9 +908,9 @@ If Web3 is not connected. Call the `connect` method first. #### Defined in -[src/nevermined/NvmApp.ts:445](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L445) +[src/nevermined/NvmApp.ts:445](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L445) ---- +___ ### updateAssetAsync @@ -920,10 +920,10 @@ Updates the asset with the specified DID using the provided metadata. #### Parameters -| Name | Type | Description | -| :--------- | :-------------------------------------- | :--------------------------------------------------------- | -| `did` | `string` | The DID (Decentralized Identifier) of the asset to update. | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | The updated metadata for the asset. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The DID (Decentralized Identifier) of the asset to update. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | The updated metadata for the asset. | #### Returns @@ -933,9 +933,9 @@ A Promise that resolves to the updated DDO (Decentralized Data Object) of the as #### Defined in -[src/nevermined/NvmApp.ts:467](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L467) +[src/nevermined/NvmApp.ts:467](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L467) ---- +___ ### validateFileAssetMetadata @@ -943,8 +943,8 @@ A Promise that resolves to the updated DDO (Decentralized Data Object) of the as #### Parameters -| Name | Type | -| :---------------------- | :-------------------------------------- | +| Name | Type | +| :------ | :------ | | `_susbcriptionMetadata` | [`MetaData`](../interfaces/MetaData.md) | #### Returns @@ -953,9 +953,9 @@ A Promise that resolves to the updated DDO (Decentralized Data Object) of the as #### Defined in -[src/nevermined/NvmApp.ts:888](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L888) +[src/nevermined/NvmApp.ts:888](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L888) ---- +___ ### validateServiceAssetMetadata @@ -963,8 +963,8 @@ A Promise that resolves to the updated DDO (Decentralized Data Object) of the as #### Parameters -| Name | Type | -| :---------------------- | :-------------------------------------- | +| Name | Type | +| :------ | :------ | | `_susbcriptionMetadata` | [`MetaData`](../interfaces/MetaData.md) | #### Returns @@ -973,9 +973,9 @@ A Promise that resolves to the updated DDO (Decentralized Data Object) of the as #### Defined in -[src/nevermined/NvmApp.ts:881](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L881) +[src/nevermined/NvmApp.ts:881](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L881) ---- +___ ### validateSubscription @@ -983,10 +983,10 @@ A Promise that resolves to the updated DDO (Decentralized Data Object) of the as #### Parameters -| Name | Type | -| :----------------- | :------------------------------------------------- | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | -| `price` | [`AssetPrice`](AssetPrice.md) | +| Name | Type | +| :------ | :------ | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `price` | [`AssetPrice`](AssetPrice.md) | | `subscriptionType` | [`SubscriptionType`](../enums/SubscriptionType.md) | #### Returns @@ -995,9 +995,9 @@ A Promise that resolves to the updated DDO (Decentralized Data Object) of the as #### Defined in -[src/nevermined/NvmApp.ts:855](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L855) +[src/nevermined/NvmApp.ts:855](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L855) ---- +___ ### getConfigFromTagName @@ -1005,8 +1005,8 @@ A Promise that resolves to the updated DDO (Decentralized Data Object) of the as #### Parameters -| Name | Type | -| :------- | :----------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `appEnv` | [`NVMAppEnvironments`](../enums/NVMAppEnvironments.md) | #### Returns @@ -1015,9 +1015,9 @@ A Promise that resolves to the updated DDO (Decentralized Data Object) of the as #### Defined in -[src/nevermined/NvmApp.ts:892](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L892) +[src/nevermined/NvmApp.ts:892](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L892) ---- +___ ### getInstance @@ -1027,9 +1027,9 @@ Returns an instance of the NvmApp class. #### Parameters -| Name | Type | Description | -| :-------- | :------------------------------------------------------- | :------------------------------------------------------ | -| `appEnv` | [`NVMAppEnvironments`](../enums/NVMAppEnvironments.md) | The environment for the NvmApp instance. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `appEnv` | [`NVMAppEnvironments`](../enums/NVMAppEnvironments.md) | The environment for the NvmApp instance. | | `config?` | `Partial`\<[`NeverminedOptions`](NeverminedOptions.md)\> | Optional configuration options for the NvmApp instance. | #### Returns @@ -1040,9 +1040,9 @@ A Promise that resolves to an instance of the NvmApp class. #### Defined in -[src/nevermined/NvmApp.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L108) +[src/nevermined/NvmApp.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L108) ---- +___ ### switchConfigBetweenEnvs @@ -1050,8 +1050,8 @@ A Promise that resolves to an instance of the NvmApp class. #### Parameters -| Name | Type | -| :------- | :----------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `appEnv` | [`NVMAppEnvironments`](../enums/NVMAppEnvironments.md) | #### Returns @@ -1060,4 +1060,4 @@ A Promise that resolves to an instance of the NvmApp class. #### Defined in -[src/nevermined/NvmApp.ts:897](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L897) +[src/nevermined/NvmApp.ts:897](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L897) diff --git a/docs/nevermined-sdk/api-reference/classes/NvmAppMetadata.md b/docs/nevermined-sdk/api-reference/classes/NvmAppMetadata.md index 880e718504..c8b56157a7 100644 --- a/docs/nevermined-sdk/api-reference/classes/NvmAppMetadata.md +++ b/docs/nevermined-sdk/api-reference/classes/NvmAppMetadata.md @@ -37,10 +37,10 @@ It returns a metadata template for a credits limitted subscription #### Parameters -| Name | Type | Description | -| :----------- | :------- | :------------------------------------------------ | -| `name` | `string` | the name of the subscription | -| `author` | `string` | the author of the subscrpiton | +| Name | Type | Description | +| :------ | :------ | :------ | +| `name` | `string` | the name of the subscription | +| `author` | `string` | the author of the subscrpiton | | `customData` | `Object` | any key-value pair to be included in the metadata | #### Returns @@ -51,9 +51,9 @@ Metadata #### Defined in -[src/ddo/NvmAppMetadata.ts:46](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/NvmAppMetadata.ts#L46) +[src/ddo/NvmAppMetadata.ts:46](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/NvmAppMetadata.ts#L46) ---- +___ ### getFileMetadataTemplate @@ -63,10 +63,10 @@ It gets a metadata template for a file type of asset (datasets, moldels, algorit #### Parameters -| Name | Type | Description | -| :----------- | :------- | :--------------------------------------------- | -| `name` | `string` | the name of the asset | -| `author` | `string` | the autor of the asset | +| Name | Type | Description | +| :------ | :------ | :------ | +| `name` | `string` | the name of the asset | +| `author` | `string` | the autor of the asset | | `customData` | `Object` | key-value pairs to be included in the metadata | #### Returns @@ -77,9 +77,9 @@ Metadata #### Defined in -[src/ddo/NvmAppMetadata.ts:192](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/NvmAppMetadata.ts#L192) +[src/ddo/NvmAppMetadata.ts:192](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/NvmAppMetadata.ts#L192) ---- +___ ### getServiceMetadataTemplate @@ -89,21 +89,21 @@ It returns a metadata template for Web Service #### Parameters -| Name | Type | Default value | Description | -| :---------------- | :----------------------------------------------- | :------------ | :----------------------------------------------------------------------- | -| `name` | `string` | `undefined` | the name of the subscription | -| `author` | `string` | `undefined` | the author of the subscrpiton | -| `endpoints` | \{ `[verb: string]`: `string`; }[] | `undefined` | the list of endpoints | -| `openEndpoints` | `string`[] | `undefined` | the list of open endpoints (not protected) | -| `openApiEndpoint` | `undefined` \| `string` | `undefined` | the openApi endpoint endpoint if any | -| `serviceType` | `string` | `'RESTful'` | the type of the service | -| `authType` | `"none"` \| `"basic"` \| `"bearer"` \| `"oauth"` | `undefined` | the type of authentication required by the service | -| `authToken?` | `string` | `undefined` | the token to be used for authentication (if authType is oauth or bearer) | -| `authUser?` | `string` | `undefined` | the username to be used for authentication (if authType is basic) | -| `authPassword?` | `string` | `undefined` | the password to be used for authentication (if authType is basic) | -| `isPriceDynamic` | `boolean` | `false` | if the price is dynamic | -| `customData` | `Object` | `{}` | any key-value pair to be included in the metadata | -| `nonce` | `string` \| `number` | `undefined` | the nonce to be included in the metadata | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `name` | `string` | `undefined` | the name of the subscription | +| `author` | `string` | `undefined` | the author of the subscrpiton | +| `endpoints` | \{ `[verb: string]`: `string`; }[] | `undefined` | the list of endpoints | +| `openEndpoints` | `string`[] | `undefined` | the list of open endpoints (not protected) | +| `openApiEndpoint` | `undefined` \| `string` | `undefined` | the openApi endpoint endpoint if any | +| `serviceType` | `string` | `'RESTful'` | the type of the service | +| `authType` | ``"none"`` \| ``"basic"`` \| ``"bearer"`` \| ``"oauth"`` | `undefined` | the type of authentication required by the service | +| `authToken?` | `string` | `undefined` | the token to be used for authentication (if authType is oauth or bearer) | +| `authUser?` | `string` | `undefined` | the username to be used for authentication (if authType is basic) | +| `authPassword?` | `string` | `undefined` | the password to be used for authentication (if authType is basic) | +| `isPriceDynamic` | `boolean` | `false` | if the price is dynamic | +| `customData` | `Object` | `{}` | any key-value pair to be included in the metadata | +| `nonce` | `string` \| `number` | `undefined` | the nonce to be included in the metadata | #### Returns @@ -113,9 +113,9 @@ Metadata #### Defined in -[src/ddo/NvmAppMetadata.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/NvmAppMetadata.ts#L115) +[src/ddo/NvmAppMetadata.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/NvmAppMetadata.ts#L115) ---- +___ ### getSubscriptionMetadataTemplate @@ -125,10 +125,10 @@ It returns a metadata template for subscription #### Parameters -| Name | Type | Description | -| :----------- | :------- | :------------------------------------------------ | -| `name` | `string` | the name of the subscription | -| `author` | `string` | the author of the subscrpiton | +| Name | Type | Description | +| :------ | :------ | :------ | +| `name` | `string` | the name of the subscription | +| `author` | `string` | the author of the subscrpiton | | `customData` | `Object` | any key-value pair to be included in the metadata | #### Returns @@ -139,9 +139,9 @@ Metadata #### Defined in -[src/ddo/NvmAppMetadata.ts:71](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/NvmAppMetadata.ts#L71) +[src/ddo/NvmAppMetadata.ts:71](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/NvmAppMetadata.ts#L71) ---- +___ ### getTimeSubscriptionMetadataTemplate @@ -151,12 +151,12 @@ It returns a metadata template for a subscription with time limit #### Parameters -| Name | Type | Description | -| :------------ | :------- | :------------------------------------------------ | -| `name` | `string` | the name of the subscription | -| `author` | `string` | the author of the subscrpiton | -| `timeMeasure` | `string` | the string defining the time measure | -| `customData` | `Object` | any key-value pair to be included in the metadata | +| Name | Type | Description | +| :------ | :------ | :------ | +| `name` | `string` | the name of the subscription | +| `author` | `string` | the author of the subscrpiton | +| `timeMeasure` | `string` | the string defining the time measure | +| `customData` | `Object` | any key-value pair to be included in the metadata | #### Returns @@ -166,9 +166,9 @@ Metadata #### Defined in -[src/ddo/NvmAppMetadata.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/NvmAppMetadata.ts#L19) +[src/ddo/NvmAppMetadata.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/NvmAppMetadata.ts#L19) ---- +___ ### validateSubscription @@ -176,9 +176,9 @@ Metadata #### Parameters -| Name | Type | -| :----------------- | :------------------------------------------------- | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| Name | Type | +| :------ | :------ | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | | `subscriptionType` | [`SubscriptionType`](../enums/SubscriptionType.md) | #### Returns @@ -187,4 +187,4 @@ Metadata #### Defined in -[src/ddo/NvmAppMetadata.ts:216](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/NvmAppMetadata.ts#L216) +[src/ddo/NvmAppMetadata.ts:216](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/NvmAppMetadata.ts#L216) diff --git a/docs/nevermined-sdk/api-reference/classes/Permissions.md b/docs/nevermined-sdk/api-reference/classes/Permissions.md index 24a21236e9..6442b32c9b 100644 --- a/docs/nevermined-sdk/api-reference/classes/Permissions.md +++ b/docs/nevermined-sdk/api-reference/classes/Permissions.md @@ -50,8 +50,8 @@ #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -64,7 +64,7 @@ #### Defined in -[src/services/metadata/MarketplaceAPI.ts:7](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L7) +[src/services/metadata/MarketplaceAPI.ts:7](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L7) ## Accessors @@ -82,9 +82,9 @@ MarketplaceApi.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -100,9 +100,9 @@ MarketplaceApi.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -118,9 +118,9 @@ MarketplaceApi.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -136,9 +136,9 @@ MarketplaceApi.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -154,9 +154,9 @@ MarketplaceApi.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -172,9 +172,9 @@ MarketplaceApi.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -190,9 +190,9 @@ MarketplaceApi.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -208,9 +208,9 @@ MarketplaceApi.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -220,69 +220,69 @@ MarketplaceApi.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -290,9 +290,9 @@ MarketplaceApi.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### url @@ -308,9 +308,9 @@ MarketplaceApi.url #### Defined in -[src/services/metadata/MarketplaceAPI.ts:12](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L12) +[src/services/metadata/MarketplaceAPI.ts:12](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L12) ---- +___ ### walletClient @@ -320,38 +320,38 @@ MarketplaceApi.url `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -359,7 +359,7 @@ MarketplaceApi.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -369,8 +369,8 @@ MarketplaceApi.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `clientAssertion` | `string` | #### Returns @@ -383,9 +383,9 @@ MarketplaceApi.walletClient #### Defined in -[src/services/metadata/MarketplaceAPI.ts:36](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L36) +[src/services/metadata/MarketplaceAPI.ts:36](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L36) ---- +___ ### create @@ -395,8 +395,8 @@ Create Permission #### Parameters -| Name | Type | -| :-------------- | :------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `newPermission` | [`NewPermission`](../interfaces/NewPermission.md) | #### Returns @@ -405,9 +405,9 @@ Create Permission #### Defined in -[src/services/metadata/Permissions.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/Permissions.ts#L18) +[src/services/metadata/Permissions.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/Permissions.ts#L18) ---- +___ ### deleteOneById @@ -417,8 +417,8 @@ Delele a bookmark by id #### Parameters -| Name | Type | -| :--- | :------- | +| Name | Type | +| :------ | :------ | | `id` | `string` | #### Returns @@ -427,9 +427,9 @@ Delele a bookmark by id #### Defined in -[src/services/metadata/Permissions.ts:142](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/Permissions.ts#L142) +[src/services/metadata/Permissions.ts:142](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/Permissions.ts#L142) ---- +___ ### findManyByUserId @@ -439,9 +439,9 @@ Get permissions by userId #### Parameters -| Name | Type | -| :------- | :-------------------------------------------- | -| `userId` | `string` | +| Name | Type | +| :------ | :------ | +| `userId` | `string` | | `query?` | [`SearchQuery`](../interfaces/SearchQuery.md) | #### Returns @@ -450,9 +450,9 @@ Get permissions by userId #### Defined in -[src/services/metadata/Permissions.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/Permissions.ts#L67) +[src/services/metadata/Permissions.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/Permissions.ts#L67) ---- +___ ### findManyByUserIdAndType @@ -462,11 +462,11 @@ Get permissions by userId and specific type #### Parameters -| Name | Type | -| :------- | :--------------------------------------------- | -| `userId` | `string` | -| `type` | [`PermissionType`](../enums/PermissionType.md) | -| `query?` | [`SearchQuery`](../interfaces/SearchQuery.md) | +| Name | Type | +| :------ | :------ | +| `userId` | `string` | +| `type` | [`PermissionType`](../enums/PermissionType.md) | +| `query?` | [`SearchQuery`](../interfaces/SearchQuery.md) | #### Returns @@ -474,9 +474,9 @@ Get permissions by userId and specific type #### Defined in -[src/services/metadata/Permissions.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/Permissions.ts#L92) +[src/services/metadata/Permissions.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/Permissions.ts#L92) ---- +___ ### findOneById @@ -486,8 +486,8 @@ Get a permission by Id #### Parameters -| Name | Type | -| :--- | :------- | +| Name | Type | +| :------ | :------ | | `id` | `string` | #### Returns @@ -496,9 +496,9 @@ Get a permission by Id #### Defined in -[src/services/metadata/Permissions.ts:45](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/Permissions.ts#L45) +[src/services/metadata/Permissions.ts:45](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/Permissions.ts#L45) ---- +___ ### login @@ -506,8 +506,8 @@ Get a permission by Id #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `clientAssertion` | `string` | #### Returns @@ -520,9 +520,9 @@ Get a permission by Id #### Defined in -[src/services/metadata/MarketplaceAPI.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L16) +[src/services/metadata/MarketplaceAPI.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L16) ---- +___ ### setInstanceConfig @@ -530,8 +530,8 @@ Get a permission by Id #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -544,9 +544,9 @@ Get a permission by Id #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### updateOneById @@ -556,9 +556,9 @@ Update a Permission by id #### Parameters -| Name | Type | -| :----------- | :------------------------------------------------------- | -| `id` | `string` | +| Name | Type | +| :------ | :------ | +| `id` | `string` | | `permission` | `Partial`\<[`Permission`](../interfaces/Permission.md)\> | #### Returns @@ -567,9 +567,9 @@ Update a Permission by id #### Defined in -[src/services/metadata/Permissions.ts:118](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/Permissions.ts#L118) +[src/services/metadata/Permissions.ts:118](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/Permissions.ts#L118) ---- +___ ### getInstance @@ -577,8 +577,8 @@ Update a Permission by id #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -591,9 +591,9 @@ Update a Permission by id #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -601,15 +601,15 @@ Update a Permission by id #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -622,4 +622,4 @@ Update a Permission by id #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/Profiles.md b/docs/nevermined-sdk/api-reference/classes/Profiles.md index 6f3aa34d83..a3ca610b49 100644 --- a/docs/nevermined-sdk/api-reference/classes/Profiles.md +++ b/docs/nevermined-sdk/api-reference/classes/Profiles.md @@ -49,8 +49,8 @@ #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -63,7 +63,7 @@ #### Defined in -[src/services/metadata/MarketplaceAPI.ts:7](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L7) +[src/services/metadata/MarketplaceAPI.ts:7](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L7) ## Accessors @@ -81,9 +81,9 @@ MarketplaceApi.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -99,9 +99,9 @@ MarketplaceApi.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -117,9 +117,9 @@ MarketplaceApi.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -135,9 +135,9 @@ MarketplaceApi.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -153,9 +153,9 @@ MarketplaceApi.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -171,9 +171,9 @@ MarketplaceApi.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -189,9 +189,9 @@ MarketplaceApi.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -207,9 +207,9 @@ MarketplaceApi.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -219,69 +219,69 @@ MarketplaceApi.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -289,9 +289,9 @@ MarketplaceApi.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### url @@ -307,9 +307,9 @@ MarketplaceApi.url #### Defined in -[src/services/metadata/MarketplaceAPI.ts:12](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L12) +[src/services/metadata/MarketplaceAPI.ts:12](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L12) ---- +___ ### walletClient @@ -319,38 +319,38 @@ MarketplaceApi.url `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -358,7 +358,7 @@ MarketplaceApi.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -368,8 +368,8 @@ MarketplaceApi.walletClient #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `clientAssertion` | `string` | #### Returns @@ -382,9 +382,9 @@ MarketplaceApi.walletClient #### Defined in -[src/services/metadata/MarketplaceAPI.ts:36](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L36) +[src/services/metadata/MarketplaceAPI.ts:36](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L36) ---- +___ ### create @@ -394,8 +394,8 @@ Create user profile #### Parameters -| Name | Type | -| :----------- | :------------------------------------------ | +| Name | Type | +| :------ | :------ | | `newProfile` | [`NewProfile`](../interfaces/NewProfile.md) | #### Returns @@ -404,9 +404,9 @@ Create user profile #### Defined in -[src/services/metadata/Profiles.ts:11](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/Profiles.ts#L11) +[src/services/metadata/Profiles.ts:11](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/Profiles.ts#L11) ---- +___ ### disableOneByUserId @@ -414,8 +414,8 @@ Create user profile #### Parameters -| Name | Type | -| :------- | :------- | +| Name | Type | +| :------ | :------ | | `userId` | `string` | #### Returns @@ -424,9 +424,9 @@ Create user profile #### Defined in -[src/services/metadata/Profiles.ts:95](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/Profiles.ts#L95) +[src/services/metadata/Profiles.ts:95](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/Profiles.ts#L95) ---- +___ ### findOneByAddress @@ -434,8 +434,8 @@ Create user profile #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `address` | `string` | #### Returns @@ -444,9 +444,9 @@ Create user profile #### Defined in -[src/services/metadata/Profiles.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/Profiles.ts#L76) +[src/services/metadata/Profiles.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/Profiles.ts#L76) ---- +___ ### findOneByUserId @@ -454,8 +454,8 @@ Create user profile #### Parameters -| Name | Type | -| :------- | :------- | +| Name | Type | +| :------ | :------ | | `userId` | `string` | #### Returns @@ -464,9 +464,9 @@ Create user profile #### Defined in -[src/services/metadata/Profiles.ts:55](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/Profiles.ts#L55) +[src/services/metadata/Profiles.ts:55](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/Profiles.ts#L55) ---- +___ ### login @@ -474,8 +474,8 @@ Create user profile #### Parameters -| Name | Type | -| :---------------- | :------- | +| Name | Type | +| :------ | :------ | | `clientAssertion` | `string` | #### Returns @@ -488,9 +488,9 @@ Create user profile #### Defined in -[src/services/metadata/MarketplaceAPI.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MarketplaceAPI.ts#L16) +[src/services/metadata/MarketplaceAPI.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MarketplaceAPI.ts#L16) ---- +___ ### setInstanceConfig @@ -498,8 +498,8 @@ Create user profile #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -512,9 +512,9 @@ Create user profile #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### update @@ -524,9 +524,9 @@ Update user profile #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------------- | -| `userId` | `string` | +| Name | Type | +| :------ | :------ | +| `userId` | `string` | | `profile` | `Partial`\<[`NewProfile`](../interfaces/NewProfile.md)\> | #### Returns @@ -535,9 +535,9 @@ Update user profile #### Defined in -[src/services/metadata/Profiles.ts:34](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/Profiles.ts#L34) +[src/services/metadata/Profiles.ts:34](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/Profiles.ts#L34) ---- +___ ### getInstance @@ -545,8 +545,8 @@ Update user profile #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -559,9 +559,9 @@ Update user profile #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -569,15 +569,15 @@ Update user profile #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -590,4 +590,4 @@ Update user profile #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/ProvenanceApi.md b/docs/nevermined-sdk/api-reference/classes/ProvenanceApi.md index c4117b3c3f..47b41b01ae 100644 --- a/docs/nevermined-sdk/api-reference/classes/ProvenanceApi.md +++ b/docs/nevermined-sdk/api-reference/classes/ProvenanceApi.md @@ -58,8 +58,8 @@ Creates a new ProvenanceApi #### Parameters -| Name | Type | Description | -| :------- | :---------------------------------------------------------- | :--------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Configuration of the Nevermined instance | #### Returns @@ -74,7 +74,7 @@ Creates a new ProvenanceApi #### Defined in -[src/nevermined/api/ProvenanceApi.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ProvenanceApi.ts#L18) +[src/nevermined/api/ProvenanceApi.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ProvenanceApi.ts#L18) ## Accessors @@ -92,9 +92,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -110,9 +110,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -128,9 +128,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -146,9 +146,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -164,9 +164,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -182,9 +182,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -200,9 +200,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -218,9 +218,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -230,69 +230,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -300,9 +300,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -312,38 +312,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -351,7 +351,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -363,17 +363,17 @@ Implements the W3C PROV Delegation action. #### Parameters -| Name | Type | Description | -| :------------------- | :---------------------------------------------- | :------------------------------------------------- | -| `provenanceId` | `string` | Provenance ID | -| `did` | `string` | Identifier of the entity created | -| `delegateAgentId` | `string` | Delegate Agent Identifier | -| `responsibleAgentId` | `string` | Responsible Agent Identifier | -| `activityId` | `string` | Identifier of the activity creating the new entity | -| `signature` | `string` | Signature provided by the delegated agent | -| `attributes` | `string` | Attributes associated with the action | -| `from` | [`NvmAccount`](NvmAccount.md) | Sender account. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `provenanceId` | `string` | Provenance ID | +| `did` | `string` | Identifier of the entity created | +| `delegateAgentId` | `string` | Delegate Agent Identifier | +| `responsibleAgentId` | `string` | Responsible Agent Identifier | +| `activityId` | `string` | Identifier of the activity creating the new entity | +| `signature` | `string` | Signature provided by the delegated agent | +| `attributes` | `string` | Attributes associated with the action | +| `from` | [`NvmAccount`](NvmAccount.md) | Sender account. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -387,9 +387,9 @@ This method can be called when want to track the delegation of an agent to act o #### Defined in -[src/nevermined/api/ProvenanceApi.ts:163](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ProvenanceApi.ts#L163) +[src/nevermined/api/ProvenanceApi.ts:163](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ProvenanceApi.ts#L163) ---- +___ ### addDidProvenanceDelegate @@ -399,12 +399,12 @@ Add new DID provenance delegate. The delegate will be able to perform actions on #### Parameters -| Name | Type | Description | -| :----------------- | :---------------------------------------------- | :------------------------------- | -| `did` | `string` | Identifier of the entity created | -| `delegatedAddress` | `string` | Delegate Address | -| `from` | [`NvmAccount`](NvmAccount.md) | Sender account. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | Identifier of the entity created | +| `delegatedAddress` | `string` | Delegate Address | +| `from` | [`NvmAccount`](NvmAccount.md) | Sender account. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -414,57 +414,57 @@ true if the call succeeded. #### Defined in -[src/nevermined/api/ProvenanceApi.ts:196](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ProvenanceApi.ts#L196) +[src/nevermined/api/ProvenanceApi.ts:196](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ProvenanceApi.ts#L196) ---- +___ ### getDIDProvenanceEvents -▸ **getDIDProvenanceEvents**(`did`): `Promise`\<\{ `activityId`: `string` ; `agentId`: `string` ; `agentInvolvedId`: `string` ; `attributes?`: `string` ; `blockNumberUpdated`: `number` ; `did`: `string` ; `id`: `string` ; `method`: `number` ; `provId`: `string` ; `relatedDid`: `string` }[]\> +▸ **getDIDProvenanceEvents**(`did`): `Promise`\<\{ `activityId`: `string` ; `agentId`: `string` ; `agentInvolvedId`: `string` ; `attributes?`: `string` ; `blockNumberUpdated`: `number` ; `did`: `string` ; `id`: `string` ; `method`: `number` ; `provId`: `string` ; `relatedDid`: `string` }[]\> Search for ProvenanceAttributeRegistered events related with a specific DID #### Parameters -| Name | Type | Description | -| :---- | :------- | :------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `did` | `string` | identifier of the entity created | #### Returns -`Promise`\<\{ `activityId`: `string` ; `agentId`: `string` ; `agentInvolvedId`: `string` ; `attributes?`: `string` ; `blockNumberUpdated`: `number` ; `did`: `string` ; `id`: `string` ; `method`: `number` ; `provId`: `string` ; `relatedDid`: `string` }[]\> +`Promise`\<\{ `activityId`: `string` ; `agentId`: `string` ; `agentInvolvedId`: `string` ; `attributes?`: `string` ; `blockNumberUpdated`: `number` ; `did`: `string` ; `id`: `string` ; `method`: `number` ; `provId`: `string` ; `relatedDid`: `string` }[]\> A list of provenance events. #### Defined in -[src/nevermined/api/ProvenanceApi.ts:258](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ProvenanceApi.ts#L258) +[src/nevermined/api/ProvenanceApi.ts:258](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ProvenanceApi.ts#L258) ---- +___ ### getProvenanceEntry -▸ **getProvenanceEntry**(`provenanceId`): `Promise`\<`undefined` \| \{ `activityId`: `any` ; `agentId`: `any` ; `agentInvolvedId`: `any` ; `blockNumberUpdated`: `any` ; `createdBy`: `any` ; `did`: `any` ; `method`: [`ProvenanceMethod`](../enums/ProvenanceMethod.md) ; `relatedDid`: `any` ; `signatureDelegate`: `any` }\> +▸ **getProvenanceEntry**(`provenanceId`): `Promise`\<`undefined` \| \{ `activityId`: `any` ; `agentId`: `any` ; `agentInvolvedId`: `any` ; `blockNumberUpdated`: `any` ; `createdBy`: `any` ; `did`: `any` ; `method`: [`ProvenanceMethod`](../enums/ProvenanceMethod.md) ; `relatedDid`: `any` ; `signatureDelegate`: `any` }\> Given a provenance id it returns the provenance details #### Parameters -| Name | Type | Description | -| :------------- | :------- | :-------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `provenanceId` | `string` | Unique identifier of a provenance entry | #### Returns -`Promise`\<`undefined` \| \{ `activityId`: `any` ; `agentId`: `any` ; `agentInvolvedId`: `any` ; `blockNumberUpdated`: `any` ; `createdBy`: `any` ; `did`: `any` ; `method`: [`ProvenanceMethod`](../enums/ProvenanceMethod.md) ; `relatedDid`: `any` ; `signatureDelegate`: `any` }\> +`Promise`\<`undefined` \| \{ `activityId`: `any` ; `agentId`: `any` ; `agentInvolvedId`: `any` ; `blockNumberUpdated`: `any` ; `createdBy`: `any` ; `did`: `any` ; `method`: [`ProvenanceMethod`](../enums/ProvenanceMethod.md) ; `relatedDid`: `any` ; `signatureDelegate`: `any` }\> [ProvenanceRegistry](../interfaces/ProvenanceRegistry.md) object with the provenance details #### Defined in -[src/nevermined/api/ProvenanceApi.ts:28](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ProvenanceApi.ts#L28) +[src/nevermined/api/ProvenanceApi.ts:28](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ProvenanceApi.ts#L28) ---- +___ ### getProvenanceMethodEvents @@ -474,16 +474,16 @@ Search for ProvenanceAttributeRegistered events related with a specific DID #### Type parameters -| Name | Type | -| :--- | :--------------------------------------------------------- | -| `T` | extends [`ProvenanceMethod`](../enums/ProvenanceMethod.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`ProvenanceMethod`](../enums/ProvenanceMethod.md) | #### Parameters -| Name | Type | Description | -| :------- | :------- | :------------------------------- | -| `method` | `T` | Method | -| `did` | `string` | Identifier of the entity created | +| Name | Type | Description | +| :------ | :------ | :------ | +| `method` | `T` | Method | +| `did` | `string` | Identifier of the entity created | #### Returns @@ -493,9 +493,9 @@ A list of provenance method events. #### Defined in -[src/nevermined/api/ProvenanceApi.ts:268](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ProvenanceApi.ts#L268) +[src/nevermined/api/ProvenanceApi.ts:268](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ProvenanceApi.ts#L268) ---- +___ ### getProvenanceOwner @@ -505,8 +505,8 @@ Retrieve the owner of the provenance record. #### Parameters -| Name | Type | Description | -| :---- | :------- | :------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `did` | `string` | Identifier of the entity created | #### Returns @@ -517,9 +517,9 @@ Address of the provenance owner. #### Defined in -[src/nevermined/api/ProvenanceApi.ts:249](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ProvenanceApi.ts#L249) +[src/nevermined/api/ProvenanceApi.ts:249](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ProvenanceApi.ts#L249) ---- +___ ### isProvenanceDelegate @@ -529,10 +529,10 @@ Check whether a given DID delegate exists #### Parameters -| Name | Type | Description | -| :----------------- | :------- | :------------------------------- | -| `did` | `string` | Identifier of the entity created | -| `delegatedAddress` | `string` | Delegate Address | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | Identifier of the entity created | +| `delegatedAddress` | `string` | Delegate Address | #### Returns @@ -542,9 +542,9 @@ true if the address is a delegate. #### Defined in -[src/nevermined/api/ProvenanceApi.ts:240](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ProvenanceApi.ts#L240) +[src/nevermined/api/ProvenanceApi.ts:240](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ProvenanceApi.ts#L240) ---- +___ ### removeDidProvenanceDelegate @@ -554,12 +554,12 @@ Remove an existing DID as delegate. #### Parameters -| Name | Type | Description | -| :----------------- | :---------------------------------------------- | :------------------------------- | -| `did` | `string` | Identifier of the entity created | -| `delegatedAddress` | `string` | Delegate Address | -| `from` | [`NvmAccount`](NvmAccount.md) | Sender account. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | Identifier of the entity created | +| `delegatedAddress` | `string` | Delegate Address | +| `from` | [`NvmAccount`](NvmAccount.md) | Sender account. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -569,9 +569,9 @@ true if the call succeeded. #### Defined in -[src/nevermined/api/ProvenanceApi.ts:219](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ProvenanceApi.ts#L219) +[src/nevermined/api/ProvenanceApi.ts:219](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ProvenanceApi.ts#L219) ---- +___ ### setInstanceConfig @@ -579,8 +579,8 @@ true if the call succeeded. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -593,9 +593,9 @@ true if the call succeeded. #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### used @@ -605,16 +605,16 @@ Implements the W3C PROV Usage action. #### Parameters -| Name | Type | Description | -| :------------- | :---------------------------------------------- | :-------------------------------------------------- | -| `provenanceId` | `string` | Provenance ID | -| `did` | `string` | Identifier of the entity created | -| `agentId` | `string` | Agent Identifier | -| `activityId` | `string` | Identifier of the activity creating the new entity | -| `signature` | `string` | Signature (optional) provided by the agent involved | -| `attributes` | `string` | Attributes associated with the action | -| `from` | [`NvmAccount`](NvmAccount.md) | Sender account. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `provenanceId` | `string` | Provenance ID | +| `did` | `string` | Identifier of the entity created | +| `agentId` | `string` | Agent Identifier | +| `activityId` | `string` | Identifier of the activity creating the new entity | +| `signature` | `string` | Signature (optional) provided by the agent involved | +| `attributes` | `string` | Attributes associated with the action | +| `from` | [`NvmAccount`](NvmAccount.md) | Sender account. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -628,9 +628,9 @@ This method can be called when want to track the usage of a DID. #### Defined in -[src/nevermined/api/ProvenanceApi.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ProvenanceApi.ts#L48) +[src/nevermined/api/ProvenanceApi.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ProvenanceApi.ts#L48) ---- +___ ### wasAssociatedWith @@ -640,15 +640,15 @@ Implements the W3C PROV Association action #### Parameters -| Name | Type | Description | -| :------------- | :---------------------------------------------- | :------------------------------------------------- | -| `provenanceId` | `string` | Provenance ID | -| `did` | `string` | Identifier of the entity created | -| `agentId` | `string` | Agent Identifier | -| `activityId` | `string` | Identifier of the activity creating the new entity | -| `attributes` | `string` | Attributes associated with the action | -| `from` | [`NvmAccount`](NvmAccount.md) | Sender account. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `provenanceId` | `string` | Provenance ID | +| `did` | `string` | Identifier of the entity created | +| `agentId` | `string` | Agent Identifier | +| `activityId` | `string` | Identifier of the activity creating the new entity | +| `attributes` | `string` | Attributes associated with the action | +| `from` | [`NvmAccount`](NvmAccount.md) | Sender account. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -662,9 +662,9 @@ This method can be called when want to track the association of an agent with a #### Defined in -[src/nevermined/api/ProvenanceApi.ts:125](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ProvenanceApi.ts#L125) +[src/nevermined/api/ProvenanceApi.ts:125](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ProvenanceApi.ts#L125) ---- +___ ### wasDerivedFrom @@ -674,16 +674,16 @@ Implements the W3C PROV Derivation action #### Parameters -| Name | Type | Description | -| :-------------- | :---------------------------------------------- | :----------------------------------------------------- | -| `provenanceId` | `string` | Provenance ID | -| `newEntityDid` | `string` | Identifier of the new entity derived | -| `usedEntityDid` | `string` | Identifier of the entity used to derive the new entity | -| `agentId` | `string` | Agent Identifier | -| `activityId` | `string` | Identifier of the activity creating the new entity | -| `attributes` | `string` | Attributes associated with the action | -| `from` | [`NvmAccount`](NvmAccount.md) | Sender account. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `provenanceId` | `string` | Provenance ID | +| `newEntityDid` | `string` | Identifier of the new entity derived | +| `usedEntityDid` | `string` | Identifier of the entity used to derive the new entity | +| `agentId` | `string` | Agent Identifier | +| `activityId` | `string` | Identifier of the activity creating the new entity | +| `attributes` | `string` | Attributes associated with the action | +| `from` | [`NvmAccount`](NvmAccount.md) | Sender account. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -697,9 +697,9 @@ This method can be called when want to track the derivation of a new DID from an #### Defined in -[src/nevermined/api/ProvenanceApi.ts:87](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ProvenanceApi.ts#L87) +[src/nevermined/api/ProvenanceApi.ts:87](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ProvenanceApi.ts#L87) ---- +___ ### getInstance @@ -707,8 +707,8 @@ This method can be called when want to track the derivation of a new DID from an #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -721,9 +721,9 @@ This method can be called when want to track the derivation of a new DID from an #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -731,15 +731,15 @@ This method can be called when want to track the derivation of a new DID from an #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -752,4 +752,4 @@ This method can be called when want to track the derivation of a new DID from an #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/Providers.md b/docs/nevermined-sdk/api-reference/classes/Providers.md index ef946f3e37..cd4965582f 100644 --- a/docs/nevermined-sdk/api-reference/classes/Providers.md +++ b/docs/nevermined-sdk/api-reference/classes/Providers.md @@ -46,8 +46,8 @@ Providers API that allows the basic management of the provider accounts associat #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -60,7 +60,7 @@ Providers API that allows the basic management of the provider accounts associat #### Defined in -[src/nevermined/Provider.ts:9](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Provider.ts#L9) +[src/nevermined/Provider.ts:9](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Provider.ts#L9) ## Accessors @@ -78,9 +78,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -96,9 +96,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -114,9 +114,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -132,9 +132,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -150,9 +150,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -168,9 +168,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -186,9 +186,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -204,9 +204,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -216,69 +216,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -286,9 +286,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -298,38 +298,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -337,7 +337,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -349,12 +349,12 @@ Add a new provider in the registry for a did. #### Parameters -| Name | Type | Description | -| :------------------- | :---------------------------------------------- | :--------------------------------------------- | -| `did` | `string` | Identifier of the entity created | -| `newProviderAddress` | `string` | New provider address in the list of providers. | -| `from` | [`NvmAccount`](NvmAccount.md) | Sender account. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | Identifier of the entity created | +| `newProviderAddress` | `string` | New provider address in the list of providers. | +| `from` | [`NvmAccount`](NvmAccount.md) | Sender account. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -364,9 +364,9 @@ true if the call succeeded. #### Defined in -[src/nevermined/Provider.ts:23](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Provider.ts#L23) +[src/nevermined/Provider.ts:23](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Provider.ts#L23) ---- +___ ### list @@ -376,8 +376,8 @@ List the provider addresses for a did. #### Parameters -| Name | Type | Description | -| :---- | :------- | :------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `did` | `string` | Identifier of the entity created | #### Returns @@ -386,9 +386,9 @@ List the provider addresses for a did. #### Defined in -[src/nevermined/Provider.ts:55](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Provider.ts#L55) +[src/nevermined/Provider.ts:55](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Provider.ts#L55) ---- +___ ### remove @@ -398,12 +398,12 @@ Remove a provider in the registry for a did. #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :--------------------------------------------- | -| `did` | `string` | Identifier of the entity created | -| `addressToRemove` | `string` | New provider address in the list of providers. | -| `from` | [`NvmAccount`](NvmAccount.md) | Sender account | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | Identifier of the entity created | +| `addressToRemove` | `string` | New provider address in the list of providers. | +| `from` | [`NvmAccount`](NvmAccount.md) | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -413,9 +413,9 @@ true if the call succeeded. #### Defined in -[src/nevermined/Provider.ts:41](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Provider.ts#L41) +[src/nevermined/Provider.ts:41](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Provider.ts#L41) ---- +___ ### setInstanceConfig @@ -423,8 +423,8 @@ true if the call succeeded. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -437,9 +437,9 @@ true if the call succeeded. #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### getInstance @@ -447,8 +447,8 @@ true if the call succeeded. #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -461,9 +461,9 @@ true if the call succeeded. #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -471,15 +471,15 @@ true if the call succeeded. #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -492,4 +492,4 @@ true if the call succeeded. #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/RegistryBaseApi.md b/docs/nevermined-sdk/api-reference/classes/RegistryBaseApi.md index 3e2b6cb826..ab00ba22e3 100644 --- a/docs/nevermined-sdk/api-reference/classes/RegistryBaseApi.md +++ b/docs/nevermined-sdk/api-reference/classes/RegistryBaseApi.md @@ -79,7 +79,7 @@ Abstract class proving common functionality related with Assets registration. #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L39) +[src/nevermined/api/RegistryBaseApi.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L39) ## Accessors @@ -97,9 +97,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -115,9 +115,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -133,9 +133,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -151,9 +151,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -169,9 +169,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -187,9 +187,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -205,9 +205,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -223,9 +223,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -235,69 +235,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -305,9 +305,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -317,38 +317,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -356,7 +356,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -368,14 +368,14 @@ Given a DID, it adds a vote to the asset curation information. #### Parameters -| Name | Type | Default value | Description | -| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `newRating` | `number` | `undefined` | New average rating of the asset | -| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `newRating` | `number` | `undefined` | New average rating of the asset | +| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -385,9 +385,9 @@ Given a DID, it adds a vote to the asset curation information. #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:534](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L534) +[src/nevermined/api/RegistryBaseApi.ts:534](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L534) ---- +___ ### getPriced @@ -397,8 +397,8 @@ It returns the priced metadata information of an asset #### Parameters -| Name | Type | Description | -| :----------- | :------------------------------------------- | :-------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `assetPrice` | `undefined` \| [`AssetPrice`](AssetPrice.md) | the asset price | #### Returns @@ -409,9 +409,9 @@ It returns the priced metadata information of an asset #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:654](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L654) +[src/nevermined/api/RegistryBaseApi.ts:654](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L654) ---- +___ ### list @@ -422,13 +422,13 @@ In a Nevermined environment, when an asset is unlisted, it is not possible to be #### Parameters -| Name | Type | Default value | Description | -| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -438,9 +438,9 @@ In a Nevermined environment, when an asset is unlisted, it is not possible to be #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:482](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L482) +[src/nevermined/api/RegistryBaseApi.ts:482](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L482) ---- +___ ### orderAsset @@ -451,12 +451,12 @@ then sends the request to the publisher via the service endpoint (Node http serv #### Parameters -| Name | Type | Description | -| :----------------- | :------------------------------------------------------------ | :--------------------- | -| `did` | `string` | Decentralized ID. | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | -| `from` | [`NvmAccount`](NvmAccount.md) | Consumer account. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | Decentralized ID. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `from` | [`NvmAccount`](NvmAccount.md) | Consumer account. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -466,9 +466,9 @@ The agreement ID. #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:585](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L585) +[src/nevermined/api/RegistryBaseApi.ts:585](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L585) ---- +___ ### registerNeverminedAsset @@ -479,13 +479,13 @@ via the Nevermined APIs directly. It must accessed via the `assets`, `compute`, #### Parameters -| Name | Type | Description | -| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | -| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | +| Name | Type | Description | +| :------ | :------ | :------ | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | | `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -499,9 +499,9 @@ The metadata of the asset created (DDO) #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L52) +[src/nevermined/api/RegistryBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L52) ---- +___ ### resolveAsset @@ -512,9 +512,9 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Parameters -| Name | Type | Default value | Description | -| :------- | :------------------------------------------------- | :---------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID. | | `policy` | [`DIDResolvePolicy`](../enums/DIDResolvePolicy.md) | `DIDResolvePolicy.MetadataAPIFirst` | It specifies the resolve policy to apply. It allows to select that priorities during the asset resolution via Metadata API or Immutable URLs (IPFS, Filecoin, etc) | #### Returns @@ -525,9 +525,9 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:324](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L324) +[src/nevermined/api/RegistryBaseApi.ts:324](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L324) ---- +___ ### setInstanceConfig @@ -535,8 +535,8 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -549,9 +549,9 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### updateAsset @@ -561,13 +561,13 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Parameters -| Name | Type | Default value | Description | -| :----------------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -577,9 +577,9 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:367](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L367) +[src/nevermined/api/RegistryBaseApi.ts:367](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L367) ---- +___ ### getInstance @@ -587,8 +587,8 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -601,9 +601,9 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### getServicePlugin @@ -613,8 +613,8 @@ Initializes the default Nevermined service plugins and return that instance #### Parameters -| Name | Type | Description | -| :------- | :---------------------------------------------------------- | :---------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Nevermined config | #### Returns @@ -623,18 +623,18 @@ Initializes the default Nevermined service plugins and return that instance The Nevermined Service Plugin instance -| Name | Type | -| :----------- | :-------------------------------------------------------------------- | -| `access` | [`AccessService`](AccessService.md) | -| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | -| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | -| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | +| Name | Type | +| :------ | :------ | +| `access` | [`AccessService`](AccessService.md) | +| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | +| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | +| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:640](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L640) +[src/nevermined/api/RegistryBaseApi.ts:640](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L640) ---- +___ ### setInstanceConfig @@ -642,15 +642,15 @@ The Nevermined Service Plugin instance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -663,4 +663,4 @@ The Nevermined Service Plugin instance #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/RewardsDistributor.md b/docs/nevermined-sdk/api-reference/classes/RewardsDistributor.md index 0118c805d8..14d1a30ee0 100644 --- a/docs/nevermined-sdk/api-reference/classes/RewardsDistributor.md +++ b/docs/nevermined-sdk/api-reference/classes/RewardsDistributor.md @@ -58,8 +58,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -72,7 +72,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -86,9 +86,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -100,9 +100,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -114,9 +114,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -128,9 +128,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -142,7 +142,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -160,9 +160,9 @@ ContractBase.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -178,9 +178,9 @@ ContractBase.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -196,9 +196,9 @@ ContractBase.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -214,9 +214,9 @@ ContractBase.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -232,9 +232,9 @@ ContractBase.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -250,9 +250,9 @@ ContractBase.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -268,9 +268,9 @@ ContractBase.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -286,9 +286,9 @@ ContractBase.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -298,69 +298,69 @@ ContractBase.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -368,9 +368,9 @@ ContractBase.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -380,38 +380,38 @@ ContractBase.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -419,7 +419,7 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -430,16 +430,16 @@ ContractBase.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -451,9 +451,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### claimReward @@ -461,19 +461,19 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `amounts` | `bigint`[] | -| `receivers` | `string`[] | -| `returnAddress` | `string` | -| `lockPaymentAddress` | `string` | -| `tokenAddress` | `string` | -| `lockCondition` | `string` | -| `releaseConditions` | `string`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `did` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `returnAddress` | `string` | +| `lockPaymentAddress` | `string` | +| `tokenAddress` | `string` | +| `lockCondition` | `string` | +| `releaseConditions` | `string`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -481,9 +481,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/royalties/RewardsDistributor.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/royalties/RewardsDistributor.ts#L22) +[src/keeper/contracts/royalties/RewardsDistributor.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/royalties/RewardsDistributor.ts#L22) ---- +___ ### getFromAddress @@ -491,8 +491,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -505,24 +505,24 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -530,9 +530,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -540,11 +540,11 @@ ContractBase.walletClient #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -556,9 +556,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### send @@ -566,12 +566,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -583,9 +583,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -593,12 +593,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -610,9 +610,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -620,8 +620,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -634,9 +634,9 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### setReceivers @@ -644,11 +644,11 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :-------- | :---------------------------------------------- | -| `did` | `string` | -| `addr` | `string`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `addr` | `string`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | | `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -657,9 +657,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/royalties/RewardsDistributor.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/royalties/RewardsDistributor.ts#L19) +[src/keeper/contracts/royalties/RewardsDistributor.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/royalties/RewardsDistributor.ts#L19) ---- +___ ### someLog @@ -667,8 +667,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -681,9 +681,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -691,8 +691,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -705,9 +705,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/royalties/RewardsDistributor.ts:9](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/royalties/RewardsDistributor.ts#L9) +[src/keeper/contracts/royalties/RewardsDistributor.ts:9](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/royalties/RewardsDistributor.ts#L9) ---- +___ ### setInstanceConfig @@ -715,15 +715,15 @@ ContractBase.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -736,4 +736,4 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/RoyaltyScheme.md b/docs/nevermined-sdk/api-reference/classes/RoyaltyScheme.md index edd0cd4710..c1dfc83182 100644 --- a/docs/nevermined-sdk/api-reference/classes/RoyaltyScheme.md +++ b/docs/nevermined-sdk/api-reference/classes/RoyaltyScheme.md @@ -62,8 +62,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -76,7 +76,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -90,9 +90,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -104,9 +104,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -118,9 +118,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -132,9 +132,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -146,7 +146,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -164,9 +164,9 @@ ContractBase.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -182,9 +182,9 @@ ContractBase.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -200,9 +200,9 @@ ContractBase.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -218,9 +218,9 @@ ContractBase.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -236,9 +236,9 @@ ContractBase.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -254,9 +254,9 @@ ContractBase.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -272,9 +272,9 @@ ContractBase.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -290,9 +290,9 @@ ContractBase.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -302,69 +302,69 @@ ContractBase.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -372,9 +372,9 @@ ContractBase.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -384,38 +384,38 @@ ContractBase.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -423,7 +423,7 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -434,16 +434,16 @@ ContractBase.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -455,9 +455,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### getFromAddress @@ -465,8 +465,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -479,9 +479,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getRoyalty @@ -489,8 +489,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -499,24 +499,24 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:28](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L28) +[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:28](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L28) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -524,9 +524,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -534,11 +534,11 @@ ContractBase.walletClient #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -550,9 +550,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### send @@ -560,12 +560,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -577,9 +577,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -587,12 +587,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -604,9 +604,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -614,8 +614,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -628,9 +628,9 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### setRoyalty @@ -638,11 +638,11 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :---------- | :---------------------------------------------- | -| `did` | `string` | -| `amount` | `number` | -| `from` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `amount` | `number` | +| `from` | [`NvmAccount`](NvmAccount.md) | | `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -651,9 +651,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L24) +[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L24) ---- +___ ### someLog @@ -661,8 +661,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -675,9 +675,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -685,12 +685,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | Default value | -| :------------ | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `schemeName` | `string` | `undefined` | -| `schemeClass` | `any` | `undefined` | -| `optional` | `boolean` | `true` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `schemeName` | `string` | `undefined` | +| `schemeClass` | `any` | `undefined` | +| `optional` | `boolean` | `true` | #### Returns @@ -702,9 +702,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:9](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L9) +[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:9](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L9) ---- +___ ### setInstanceConfig @@ -712,15 +712,15 @@ ContractBase.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -733,4 +733,4 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/SearchApi.md b/docs/nevermined-sdk/api-reference/classes/SearchApi.md index 5608a5dd58..df43681609 100644 --- a/docs/nevermined-sdk/api-reference/classes/SearchApi.md +++ b/docs/nevermined-sdk/api-reference/classes/SearchApi.md @@ -58,8 +58,8 @@ Creates a new SearchApi #### Parameters -| Name | Type | Description | -| :------- | :---------------------------------------------------------- | :--------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Configuration of the Nevermined instance | #### Returns @@ -74,7 +74,7 @@ Creates a new SearchApi #### Defined in -[src/nevermined/api/SearchApi.ts:30](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/SearchApi.ts#L30) +[src/nevermined/api/SearchApi.ts:30](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/SearchApi.ts#L30) ## Accessors @@ -92,9 +92,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -110,9 +110,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -128,9 +128,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -146,9 +146,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -164,9 +164,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -182,9 +182,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -200,9 +200,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -218,9 +218,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -230,69 +230,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -300,9 +300,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -312,38 +312,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -351,7 +351,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -363,10 +363,10 @@ Search over the assets using a keyword. #### Parameters -| Name | Type | Description | -| :------------------------- | :-------------------------- | :------------------------- | -| `did` | `string` \| [`DID`](DID.md) | DID of the asset. | -| `metadataServiceEndpoint?` | `string` | Metadata service endpoint. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` \| [`DID`](DID.md) | DID of the asset. | +| `metadataServiceEndpoint?` | `string` | Metadata service endpoint. | #### Returns @@ -376,9 +376,9 @@ DDO of the asset. #### Defined in -[src/nevermined/api/SearchApi.ts:41](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/SearchApi.ts#L41) +[src/nevermined/api/SearchApi.ts:41](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/SearchApi.ts#L41) ---- +___ ### byPrice @@ -388,15 +388,15 @@ Query for assets by price. #### Parameters -| Name | Type | Default value | Description | -| :------------- | :------------------------------------------------ | :------------ | :------------------------------------------------- | -| `minPrice` | `number` | `undefined` | The minimum price to search for. | -| `maxPrice` | `number` | `undefined` | The maximum price to search for. | -| `serviceType?` | [`ServiceType`](../code-reference.md#servicetype) | `undefined` | The name of the service. Defaults to all services. | -| `offset` | `number` | `100` | | -| `page` | `number` | `1` | | -| `sort` | `string` | `'desc'` | | -| `appId?` | `string` | `undefined` | | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `minPrice` | `number` | `undefined` | The minimum price to search for. | +| `maxPrice` | `number` | `undefined` | The maximum price to search for. | +| `serviceType?` | [`ServiceType`](../code-reference.md#servicetype) | `undefined` | The name of the service. Defaults to all services. | +| `offset` | `number` | `100` | | +| `page` | `number` | `1` | | +| `sort` | `string` | `'desc'` | | +| `appId?` | `string` | `undefined` | | #### Returns @@ -410,9 +410,9 @@ const results = await nevermined.search.byPrice(1, 20) #### Defined in -[src/nevermined/api/SearchApi.ts:110](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/SearchApi.ts#L110) +[src/nevermined/api/SearchApi.ts:110](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/SearchApi.ts#L110) ---- +___ ### bySubscriptionContractAddress @@ -422,27 +422,25 @@ Search for all subscription DDOs with `contractAddress` #### Parameters -| Name | Type | Default value | Description | -| :--------------------- | :---------- | :------------ | :----------------------------------------- | -| `contractAddress` | `string` | `undefined` | The address of the subscription contract | -| `nftType` | `string` | `undefined` | The nftType | -| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | -| `offset` | `number` | `100` | The number of results to return | -| `page` | `number` | `1` | | -| `sort` | `string` | `'desc'` | The sort order | -| `appId?` | `string` | `undefined` | The appId used to filter the results | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `contractAddress` | `string` | `undefined` | The address of the subscription contract | +| `nftType` | `string` | `undefined` | The nftType | +| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | +| `offset` | `number` | `100` | The number of results to return | +| `page` | `number` | `1` | | +| `sort` | `string` | `'desc'` | The sort order | +| `appId?` | `string` | `undefined` | The appId used to filter the results | #### Returns `Promise`\<[`QueryResult`](../interfaces/QueryResult.md)\> -Promise - #### Defined in -[src/nevermined/api/SearchApi.ts:163](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/SearchApi.ts#L163) +[src/nevermined/api/SearchApi.ts:163](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/SearchApi.ts#L163) ---- +___ ### byText @@ -452,13 +450,13 @@ Search over the assets using a keyword. #### Parameters -| Name | Type | Default value | Description | -| :------- | :------- | :------------ | :------------------------- | -| `text` | `string` | `undefined` | Text to filter the assets. | -| `offset` | `number` | `100` | - | -| `page` | `number` | `1` | - | -| `sort` | `string` | `'desc'` | - | -| `appId?` | `string` | `undefined` | - | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `text` | `string` | `undefined` | Text to filter the assets. | +| `offset` | `number` | `100` | - | +| `page` | `number` | `1` | - | +| `sort` | `string` | `'desc'` | - | +| `appId?` | `string` | `undefined` | - | #### Returns @@ -468,9 +466,9 @@ A list of [DDO](DDO.md)s. #### Defined in -[src/nevermined/api/SearchApi.ts:78](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/SearchApi.ts#L78) +[src/nevermined/api/SearchApi.ts:78](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/SearchApi.ts#L78) ---- +___ ### datasetsByNftContract @@ -480,28 +478,26 @@ Search of all datasets belonging to a subscription NFT contract #### Parameters -| Name | Type | Default value | Description | -| :--------------------- | :------------------------------------------------------------------------------------------------------------------------- | :------------ | :----------------------------------------- | -| `nftContractAddress` | `string` | `undefined` | The DID of the subscription. | -| `nftType?` | [`NeverminedNFT721Type`](../enums/NeverminedNFT721Type.md) \| [`NeverminedNFT1155Type`](../enums/NeverminedNFT1155Type.md) | `undefined` | - | -| `tokenId?` | `string` | `undefined` | - | -| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | -| `offset` | `number` | `100` | The number of results to return | -| `page` | `number` | `1` | | -| `sort` | `string` | `'desc'` | The sort order | -| `appId?` | `string` | `undefined` | The appId used to filter the results | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `nftContractAddress` | `string` | `undefined` | The DID of the subscription. | +| `nftType?` | [`NeverminedNFT721Type`](../enums/NeverminedNFT721Type.md) \| [`NeverminedNFT1155Type`](../enums/NeverminedNFT1155Type.md) | `undefined` | - | +| `tokenId?` | `string` | `undefined` | - | +| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | +| `offset` | `number` | `100` | The number of results to return | +| `page` | `number` | `1` | | +| `sort` | `string` | `'desc'` | The sort order | +| `appId?` | `string` | `undefined` | The appId used to filter the results | #### Returns `Promise`\<[`QueryResult`](../interfaces/QueryResult.md)\> -Promise - #### Defined in -[src/nevermined/api/SearchApi.ts:632](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/SearchApi.ts#L632) +[src/nevermined/api/SearchApi.ts:632](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/SearchApi.ts#L632) ---- +___ ### datasetsBySubscription @@ -511,27 +507,25 @@ Search of all datasets belonging to a subscription #### Parameters -| Name | Type | Default value | Description | -| :--------------------- | :------------------------------------------------------------------------------------------------------------------------- | :------------ | :----------------------------------------- | -| `subscriptionDid` | `string` | `undefined` | The DID of the subscription. | -| `nftType?` | [`NeverminedNFT721Type`](../enums/NeverminedNFT721Type.md) \| [`NeverminedNFT1155Type`](../enums/NeverminedNFT1155Type.md) | `undefined` | - | -| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | -| `offset` | `number` | `100` | The number of results to return | -| `page` | `number` | `1` | | -| `sort` | `string` | `'desc'` | The sort order | -| `appId?` | `string` | `undefined` | The appId used to filter the results | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `subscriptionDid` | `string` | `undefined` | The DID of the subscription. | +| `nftType?` | [`NeverminedNFT721Type`](../enums/NeverminedNFT721Type.md) \| [`NeverminedNFT1155Type`](../enums/NeverminedNFT1155Type.md) | `undefined` | - | +| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | +| `offset` | `number` | `100` | The number of results to return | +| `page` | `number` | `1` | | +| `sort` | `string` | `'desc'` | The sort order | +| `appId?` | `string` | `undefined` | The appId used to filter the results | #### Returns `Promise`\<[`QueryResult`](../interfaces/QueryResult.md)\> -Promise - #### Defined in -[src/nevermined/api/SearchApi.ts:753](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/SearchApi.ts#L753) +[src/nevermined/api/SearchApi.ts:753](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/SearchApi.ts#L753) ---- +___ ### query @@ -541,8 +535,8 @@ Search over the assets using a query. #### Parameters -| Name | Type | Description | -| :------ | :-------------------------------------------- | :-------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `query` | [`SearchQuery`](../interfaces/SearchQuery.md) | Query to filter the assets. | #### Returns @@ -558,9 +552,9 @@ returning only DDOs for that appId #### Defined in -[src/nevermined/api/SearchApi.ts:55](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/SearchApi.ts#L55) +[src/nevermined/api/SearchApi.ts:55](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/SearchApi.ts#L55) ---- +___ ### servicesByNftContract @@ -570,28 +564,26 @@ Search of all services belonging to a subscription nft contract #### Parameters -| Name | Type | Default value | Description | -| :--------------------- | :------------------------------------------------------------------------------------------------------------------------- | :------------ | :-------------------------------------------- | -| `nftContractAddress` | `string` | `undefined` | The NFT contract address of the subscription. | -| `nftType?` | [`NeverminedNFT721Type`](../enums/NeverminedNFT721Type.md) \| [`NeverminedNFT1155Type`](../enums/NeverminedNFT1155Type.md) | `undefined` | - | -| `tokenId?` | `string` | `undefined` | - | -| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | -| `offset` | `number` | `100` | The number of results to return | -| `page` | `number` | `1` | | -| `sort` | `string` | `'desc'` | The sort order | -| `appId?` | `string` | `undefined` | The appId used to filter the results | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `nftContractAddress` | `string` | `undefined` | The NFT contract address of the subscription. | +| `nftType?` | [`NeverminedNFT721Type`](../enums/NeverminedNFT721Type.md) \| [`NeverminedNFT1155Type`](../enums/NeverminedNFT1155Type.md) | `undefined` | - | +| `tokenId?` | `string` | `undefined` | - | +| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | +| `offset` | `number` | `100` | The number of results to return | +| `page` | `number` | `1` | | +| `sort` | `string` | `'desc'` | The sort order | +| `appId?` | `string` | `undefined` | The appId used to filter the results | #### Returns `Promise`\<[`QueryResult`](../interfaces/QueryResult.md)\> -Promise - #### Defined in -[src/nevermined/api/SearchApi.ts:472](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/SearchApi.ts#L472) +[src/nevermined/api/SearchApi.ts:472](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/SearchApi.ts#L472) ---- +___ ### servicesBySubscription @@ -601,27 +593,25 @@ Search of all services belonging to a subscription #### Parameters -| Name | Type | Default value | Description | -| :--------------------- | :------------------------------------------------------------------------------------------------------------------------- | :------------ | :----------------------------------------- | -| `subscriptionDid` | `string` | `undefined` | The DID of the subscription. | -| `nftType?` | [`NeverminedNFT721Type`](../enums/NeverminedNFT721Type.md) \| [`NeverminedNFT1155Type`](../enums/NeverminedNFT1155Type.md) | `undefined` | - | -| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | -| `offset` | `number` | `100` | The number of results to return | -| `page` | `number` | `1` | | -| `sort` | `string` | `'desc'` | The sort order | -| `appId?` | `string` | `undefined` | The appId used to filter the results | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `subscriptionDid` | `string` | `undefined` | The DID of the subscription. | +| `nftType?` | [`NeverminedNFT721Type`](../enums/NeverminedNFT721Type.md) \| [`NeverminedNFT1155Type`](../enums/NeverminedNFT1155Type.md) | `undefined` | - | +| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | +| `offset` | `number` | `100` | The number of results to return | +| `page` | `number` | `1` | | +| `sort` | `string` | `'desc'` | The sort order | +| `appId?` | `string` | `undefined` | The appId used to filter the results | #### Returns `Promise`\<[`QueryResult`](../interfaces/QueryResult.md)\> -Promise - #### Defined in -[src/nevermined/api/SearchApi.ts:582](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/SearchApi.ts#L582) +[src/nevermined/api/SearchApi.ts:582](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/SearchApi.ts#L582) ---- +___ ### setInstanceConfig @@ -629,8 +619,8 @@ Promise #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -643,9 +633,9 @@ Promise #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### subscriptionsCreated @@ -655,27 +645,25 @@ Search of all subscriptions created by `account` #### Parameters -| Name | Type | Default value | Description | -| :--------------------- | :------------------------------------------------------------------------------------------------------------------------- | :------------ | :------------------------------------------ | -| `account` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account that created the subscriptions. | -| `nftType?` | [`NeverminedNFT721Type`](../enums/NeverminedNFT721Type.md) \| [`NeverminedNFT1155Type`](../enums/NeverminedNFT1155Type.md) | `undefined` | The nftType | -| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | -| `offset` | `number` | `100` | The number of results to return | -| `page` | `number` | `1` | | -| `sort` | `string` | `'desc'` | The sort order | -| `appId?` | `string` | `undefined` | The appId used to filter the results | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `account` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account that created the subscriptions. | +| `nftType?` | [`NeverminedNFT721Type`](../enums/NeverminedNFT721Type.md) \| [`NeverminedNFT1155Type`](../enums/NeverminedNFT1155Type.md) | `undefined` | The nftType | +| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | +| `offset` | `number` | `100` | The number of results to return | +| `page` | `number` | `1` | | +| `sort` | `string` | `'desc'` | The sort order | +| `appId?` | `string` | `undefined` | The appId used to filter the results | #### Returns `Promise`\<[`QueryResult`](../interfaces/QueryResult.md)\> -Promise - #### Defined in -[src/nevermined/api/SearchApi.ts:262](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/SearchApi.ts#L262) +[src/nevermined/api/SearchApi.ts:262](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/SearchApi.ts#L262) ---- +___ ### subscriptionsPurchased @@ -685,28 +673,26 @@ Search of all subscriptions purchased by `account` #### Parameters -| Name | Type | Default value | Description | -| :--------------------- | :------------------------------------------------------------------------------------------------------------------------- | :------------ | :-------------------------------------------- | -| `account` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account that purchased the subscriptions. | -| `nftType?` | [`NeverminedNFT721Type`](../enums/NeverminedNFT721Type.md) \| [`NeverminedNFT1155Type`](../enums/NeverminedNFT1155Type.md) | `undefined` | The nftType | -| `ercType?` | `721` \| `1155` | `undefined` | - | -| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | -| `offset` | `number` | `100` | The number of results to return | -| `page` | `number` | `1` | | -| `sort` | `string` | `'desc'` | The sort order | -| `appId?` | `string` | `undefined` | The appId used to filter the results | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `account` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account that purchased the subscriptions. | +| `nftType?` | [`NeverminedNFT721Type`](../enums/NeverminedNFT721Type.md) \| [`NeverminedNFT1155Type`](../enums/NeverminedNFT1155Type.md) | `undefined` | The nftType | +| `ercType?` | ``721`` \| ``1155`` | `undefined` | - | +| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | +| `offset` | `number` | `100` | The number of results to return | +| `page` | `number` | `1` | | +| `sort` | `string` | `'desc'` | The sort order | +| `appId?` | `string` | `undefined` | The appId used to filter the results | #### Returns `Promise`\<[`QueryResult`](../interfaces/QueryResult.md)\> -Promise - #### Defined in -[src/nevermined/api/SearchApi.ts:354](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/SearchApi.ts#L354) +[src/nevermined/api/SearchApi.ts:354](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/SearchApi.ts#L354) ---- +___ ### getInstance @@ -714,8 +700,8 @@ Promise #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -728,9 +714,9 @@ Promise #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -738,15 +724,15 @@ Promise #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -759,4 +745,4 @@ Promise #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/ServiceAgreement.md b/docs/nevermined-sdk/api-reference/classes/ServiceAgreement.md index 3d4740f6c5..96e7cb778d 100644 --- a/docs/nevermined-sdk/api-reference/classes/ServiceAgreement.md +++ b/docs/nevermined-sdk/api-reference/classes/ServiceAgreement.md @@ -45,8 +45,8 @@ #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -59,7 +59,7 @@ #### Defined in -[src/nevermined/utils/ServiceAgreement.ts:9](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/ServiceAgreement.ts#L9) +[src/nevermined/utils/ServiceAgreement.ts:9](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/ServiceAgreement.ts#L9) ## Accessors @@ -77,9 +77,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -95,9 +95,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -113,9 +113,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -131,9 +131,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -149,9 +149,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -167,9 +167,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -185,9 +185,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -203,9 +203,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -215,69 +215,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -285,9 +285,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -297,38 +297,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -336,7 +336,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -346,14 +346,14 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------------------- | :---------------------------- | -| `templateId` | `string` | -| `serviceAgreementId` | `string` | -| `valueHashes` | `string`[] | -| `timelockValues` | `number`[] | -| `timeoutValues` | `number`[] | -| `consumer` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `templateId` | `string` | +| `serviceAgreementId` | `string` | +| `valueHashes` | `string`[] | +| `timelockValues` | `number`[] | +| `timeoutValues` | `number`[] | +| `consumer` | [`NvmAccount`](NvmAccount.md) | #### Returns @@ -361,9 +361,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/ServiceAgreement.ts:43](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/ServiceAgreement.ts#L43) +[src/nevermined/utils/ServiceAgreement.ts:43](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/ServiceAgreement.ts#L43) ---- +___ ### getTimeValuesFromService @@ -371,10 +371,10 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `service` | [`ServiceAccess`](../interfaces/ServiceAccess.md) | -| `type` | `"timeout"` \| `"timelock"` | +| `type` | ``"timeout"`` \| ``"timelock"`` | #### Returns @@ -382,9 +382,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/ServiceAgreement.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/ServiceAgreement.ts#L91) +[src/nevermined/utils/ServiceAgreement.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/ServiceAgreement.ts#L91) ---- +___ ### hashServiceAgreement @@ -392,13 +392,13 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------------------------- | :--------- | -| `serviceAgreementTemplateId` | `string` | -| `serviceAgreementId` | `string` | -| `valueHashes` | `string`[] | -| `timelocks` | `number`[] | -| `timeouts` | `number`[] | +| Name | Type | +| :------ | :------ | +| `serviceAgreementTemplateId` | `string` | +| `serviceAgreementId` | `string` | +| `valueHashes` | `string`[] | +| `timelocks` | `number`[] | +| `timeouts` | `number`[] | #### Returns @@ -406,9 +406,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/ServiceAgreement.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/ServiceAgreement.ts#L67) +[src/nevermined/utils/ServiceAgreement.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/ServiceAgreement.ts#L67) ---- +___ ### setInstanceConfig @@ -416,8 +416,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -430,9 +430,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### signServiceAgreement @@ -440,13 +440,13 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :----------------------- | :------------------------------------------------ | -| `ddo` | [`DDO`](DDO.md) | -| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | -| `serviceAgreementId` | `string` | -| `agreementConditionsIds` | `string`[] | -| `consumer` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | +| `serviceAgreementId` | `string` | +| `agreementConditionsIds` | `string`[] | +| `consumer` | [`NvmAccount`](NvmAccount.md) | #### Returns @@ -454,9 +454,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/ServiceAgreement.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/ServiceAgreement.ts#L14) +[src/nevermined/utils/ServiceAgreement.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/ServiceAgreement.ts#L14) ---- +___ ### getInstance @@ -464,8 +464,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -478,9 +478,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -488,15 +488,15 @@ Instantiable.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -509,4 +509,4 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/ServicesApi.md b/docs/nevermined-sdk/api-reference/classes/ServicesApi.md index 359b4e686a..ca630aa6f5 100644 --- a/docs/nevermined-sdk/api-reference/classes/ServicesApi.md +++ b/docs/nevermined-sdk/api-reference/classes/ServicesApi.md @@ -54,8 +54,8 @@ Creates a new ServicesApi #### Parameters -| Name | Type | Description | -| :------- | :---------------------------------------------------------- | :--------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Configuration of the Nevermined instance | #### Returns @@ -70,7 +70,7 @@ Creates a new ServicesApi #### Defined in -[src/nevermined/api/ServicesApi.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ServicesApi.ts#L48) +[src/nevermined/api/ServicesApi.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ServicesApi.ts#L48) ## Properties @@ -82,9 +82,9 @@ Bookmarks instance #### Defined in -[src/nevermined/api/ServicesApi.ts:41](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ServicesApi.ts#L41) +[src/nevermined/api/ServicesApi.ts:41](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ServicesApi.ts#L41) ---- +___ ### marketplace @@ -94,9 +94,9 @@ Nevermined Node Service #### Defined in -[src/nevermined/api/ServicesApi.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ServicesApi.ts#L21) +[src/nevermined/api/ServicesApi.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ServicesApi.ts#L21) ---- +___ ### metadata @@ -106,9 +106,9 @@ Marketplace instance. #### Defined in -[src/nevermined/api/ServicesApi.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ServicesApi.ts#L26) +[src/nevermined/api/ServicesApi.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ServicesApi.ts#L26) ---- +___ ### node @@ -118,9 +118,9 @@ Nevermined Node Service #### Defined in -[src/nevermined/api/ServicesApi.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ServicesApi.ts#L16) +[src/nevermined/api/ServicesApi.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ServicesApi.ts#L16) ---- +___ ### permissions @@ -130,9 +130,9 @@ Permissions service #### Defined in -[src/nevermined/api/ServicesApi.ts:31](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ServicesApi.ts#L31) +[src/nevermined/api/ServicesApi.ts:31](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ServicesApi.ts#L31) ---- +___ ### profiles @@ -142,7 +142,7 @@ Profiles instance #### Defined in -[src/nevermined/api/ServicesApi.ts:36](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/ServicesApi.ts#L36) +[src/nevermined/api/ServicesApi.ts:36](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/ServicesApi.ts#L36) ## Accessors @@ -160,9 +160,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -178,9 +178,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -196,9 +196,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -214,9 +214,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -232,9 +232,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -250,9 +250,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -268,9 +268,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -286,9 +286,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -298,69 +298,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -368,9 +368,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -380,38 +380,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -419,7 +419,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -429,8 +429,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -443,9 +443,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### getInstance @@ -453,8 +453,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -467,9 +467,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -477,15 +477,15 @@ Instantiable.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -498,4 +498,4 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/SignatureUtils.md b/docs/nevermined-sdk/api-reference/classes/SignatureUtils.md index 870adb0355..faf7bb6ada 100644 --- a/docs/nevermined-sdk/api-reference/classes/SignatureUtils.md +++ b/docs/nevermined-sdk/api-reference/classes/SignatureUtils.md @@ -47,8 +47,8 @@ #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -61,7 +61,7 @@ #### Defined in -[src/nevermined/utils/SignatureUtils.ts:9](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/SignatureUtils.ts#L9) +[src/nevermined/utils/SignatureUtils.ts:9](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/SignatureUtils.ts#L9) ## Accessors @@ -79,9 +79,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -97,9 +97,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -115,9 +115,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -133,9 +133,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -151,9 +151,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -169,9 +169,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -187,9 +187,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -205,9 +205,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -217,69 +217,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -287,9 +287,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -299,38 +299,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -338,7 +338,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -348,8 +348,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -362,9 +362,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### signText @@ -372,9 +372,9 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :-------- | :---------------------------------------- | -| `text` | `string` \| `Uint8Array` | +| Name | Type | +| :------ | :------ | +| `text` | `string` \| `Uint8Array` | | `account` | `string` \| [`NvmAccount`](NvmAccount.md) | #### Returns @@ -383,9 +383,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/SignatureUtils.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/SignatureUtils.ts#L14) +[src/nevermined/utils/SignatureUtils.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/SignatureUtils.ts#L14) ---- +___ ### signTransaction @@ -393,9 +393,9 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :-------- | :---------------------------------------- | -| `tx` | \`0x$\{string}\` | +| Name | Type | +| :------ | :------ | +| `tx` | \`0x$\{string}\` | | `account` | `string` \| [`NvmAccount`](NvmAccount.md) | #### Returns @@ -404,9 +404,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/SignatureUtils.ts:73](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/SignatureUtils.ts#L73) +[src/nevermined/utils/SignatureUtils.ts:73](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/SignatureUtils.ts#L73) ---- +___ ### signTypedData @@ -414,12 +414,12 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :-------- | :---------------------------------------------------- | -| `domain` | [`TypedDataDomain`](../interfaces/TypedDataDomain.md) | -| `types` | [`TypedDataTypes`](../interfaces/TypedDataTypes.md) | -| `value` | `Record`\<`string`, `any`\> | -| `account` | `string` \| [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `domain` | [`TypedDataDomain`](../interfaces/TypedDataDomain.md) | +| `types` | [`TypedDataTypes`](../interfaces/TypedDataTypes.md) | +| `value` | `Record`\<`string`, `any`\> | +| `account` | `string` \| [`NvmAccount`](NvmAccount.md) | #### Returns @@ -427,9 +427,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/SignatureUtils.ts:37](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/SignatureUtils.ts#L37) +[src/nevermined/utils/SignatureUtils.ts:37](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/SignatureUtils.ts#L37) ---- +___ ### verifyIsSigner @@ -437,10 +437,10 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :-------------- | :------- | -| `text` | `string` | -| `signature` | `string` | +| Name | Type | +| :------ | :------ | +| `text` | `string` | +| `signature` | `string` | | `signerAddress` | `string` | #### Returns @@ -449,9 +449,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/SignatureUtils.ts:94](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/SignatureUtils.ts#L94) +[src/nevermined/utils/SignatureUtils.ts:94](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/SignatureUtils.ts#L94) ---- +___ ### getInstance @@ -459,8 +459,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -473,9 +473,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### hash @@ -483,8 +483,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :----- | :------- | +| Name | Type | +| :------ | :------ | | `seed` | `string` | #### Returns @@ -493,9 +493,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/SignatureUtils.ts:113](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/SignatureUtils.ts#L113) +[src/nevermined/utils/SignatureUtils.ts:113](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/SignatureUtils.ts#L113) ---- +___ ### recoverSignerAddress @@ -503,9 +503,9 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :---------- | :------- | -| `message` | `string` | +| Name | Type | +| :------ | :------ | +| `message` | `string` | | `signature` | `string` | #### Returns @@ -514,9 +514,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/utils/SignatureUtils.ts:106](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/SignatureUtils.ts#L106) +[src/nevermined/utils/SignatureUtils.ts:106](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/SignatureUtils.ts#L106) ---- +___ ### setInstanceConfig @@ -524,15 +524,15 @@ Instantiable.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -545,4 +545,4 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/StandardRoyalties.md b/docs/nevermined-sdk/api-reference/classes/StandardRoyalties.md index 7f74180667..a7d31b5d56 100644 --- a/docs/nevermined-sdk/api-reference/classes/StandardRoyalties.md +++ b/docs/nevermined-sdk/api-reference/classes/StandardRoyalties.md @@ -58,8 +58,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -72,7 +72,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -86,9 +86,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -100,9 +100,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -114,9 +114,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -128,9 +128,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -142,7 +142,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -160,9 +160,9 @@ RoyaltyScheme.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -178,9 +178,9 @@ RoyaltyScheme.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -196,9 +196,9 @@ RoyaltyScheme.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -214,9 +214,9 @@ RoyaltyScheme.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -232,9 +232,9 @@ RoyaltyScheme.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -250,9 +250,9 @@ RoyaltyScheme.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -268,9 +268,9 @@ RoyaltyScheme.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -286,9 +286,9 @@ RoyaltyScheme.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -298,69 +298,69 @@ RoyaltyScheme.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -368,9 +368,9 @@ RoyaltyScheme.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -380,38 +380,38 @@ RoyaltyScheme.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -419,7 +419,7 @@ RoyaltyScheme.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -430,16 +430,16 @@ RoyaltyScheme.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -451,9 +451,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### getFromAddress @@ -461,8 +461,8 @@ RoyaltyScheme.walletClient #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -475,9 +475,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getRoyalty @@ -485,8 +485,8 @@ RoyaltyScheme.walletClient #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -499,24 +499,24 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:28](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L28) +[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:28](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L28) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -524,9 +524,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -534,11 +534,11 @@ RoyaltyScheme.walletClient #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -550,9 +550,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### send @@ -560,12 +560,12 @@ RoyaltyScheme.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -577,9 +577,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -587,12 +587,12 @@ RoyaltyScheme.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -604,9 +604,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -614,8 +614,8 @@ RoyaltyScheme.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -628,9 +628,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### setRoyalty @@ -638,11 +638,11 @@ RoyaltyScheme.walletClient #### Parameters -| Name | Type | -| :---------- | :---------------------------------------------- | -| `did` | `string` | -| `amount` | `number` | -| `from` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `amount` | `number` | +| `from` | [`NvmAccount`](NvmAccount.md) | | `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -655,9 +655,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L24) +[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L24) ---- +___ ### someLog @@ -665,8 +665,8 @@ RoyaltyScheme.walletClient #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -679,9 +679,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -689,8 +689,8 @@ RoyaltyScheme.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -703,9 +703,9 @@ RoyaltyScheme.walletClient #### Defined in -[src/keeper/contracts/royalties/StandardRoyalties.ts:5](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/royalties/StandardRoyalties.ts#L5) +[src/keeper/contracts/royalties/StandardRoyalties.ts:5](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/royalties/StandardRoyalties.ts#L5) ---- +___ ### setInstanceConfig @@ -713,15 +713,15 @@ RoyaltyScheme.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -734,4 +734,4 @@ RoyaltyScheme.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/SubgraphEvent.md b/docs/nevermined-sdk/api-reference/classes/SubgraphEvent.md index 3bb3ee9d64..715f989414 100644 --- a/docs/nevermined-sdk/api-reference/classes/SubgraphEvent.md +++ b/docs/nevermined-sdk/api-reference/classes/SubgraphEvent.md @@ -56,9 +56,9 @@ Initializes the NeverminedEvent instance #### Parameters -| Name | Type | Description | -| :------------- | :---------------------------------------------- | :---------------------------- | -| `contract` | [`ContractBase`](ContractBase.md) | contract instance | +| Name | Type | Description | +| :------ | :------ | :------ | +| `contract` | [`ContractBase`](ContractBase.md) | contract instance | | `eventEmitter` | [`EventEmitter`](../interfaces/EventEmitter.md) | events emitter implementation | #### Returns @@ -73,7 +73,7 @@ the NeverminedEvent instance #### Defined in -[src/events/NeverminedEvent.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/NeverminedEvent.ts#L26) +[src/events/NeverminedEvent.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/NeverminedEvent.ts#L26) ## Properties @@ -87,9 +87,9 @@ the NeverminedEvent instance #### Defined in -[src/events/NeverminedEvent.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/NeverminedEvent.ts#L15) +[src/events/NeverminedEvent.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/NeverminedEvent.ts#L15) ---- +___ ### eventEmitter @@ -101,9 +101,9 @@ the NeverminedEvent instance #### Defined in -[src/events/NeverminedEvent.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/NeverminedEvent.ts#L14) +[src/events/NeverminedEvent.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/NeverminedEvent.ts#L14) ---- +___ ### subgraph @@ -111,7 +111,7 @@ the NeverminedEvent instance #### Defined in -[src/events/SubgraphEvent.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/SubgraphEvent.ts#L20) +[src/events/SubgraphEvent.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/SubgraphEvent.ts#L20) ## Accessors @@ -129,9 +129,9 @@ NeverminedEvent.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -147,9 +147,9 @@ NeverminedEvent.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -165,9 +165,9 @@ NeverminedEvent.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -183,9 +183,9 @@ NeverminedEvent.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -201,9 +201,9 @@ NeverminedEvent.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -219,9 +219,9 @@ NeverminedEvent.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -237,9 +237,9 @@ NeverminedEvent.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -255,9 +255,9 @@ NeverminedEvent.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -267,69 +267,69 @@ NeverminedEvent.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -337,9 +337,9 @@ NeverminedEvent.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -349,38 +349,38 @@ NeverminedEvent.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -388,7 +388,7 @@ NeverminedEvent.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -410,9 +410,9 @@ the block number #### Defined in -[src/events/SubgraphEvent.ts:93](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/SubgraphEvent.ts#L93) +[src/events/SubgraphEvent.ts:93](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/SubgraphEvent.ts#L93) ---- +___ ### getEventData @@ -422,8 +422,8 @@ It returns the events matching a given filter #### Parameters -| Name | Type | Description | -| :-------- | :---------------------------------------------- | :------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `options` | [`EventOptions`](../interfaces/EventOptions.md) | event filter options | #### Returns @@ -438,9 +438,9 @@ It returns the events matching a given filter #### Defined in -[src/events/SubgraphEvent.ts:63](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/SubgraphEvent.ts#L63) +[src/events/SubgraphEvent.ts:63](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/SubgraphEvent.ts#L63) ---- +___ ### getPastEvents @@ -450,8 +450,8 @@ It returns the events matching a given filter #### Parameters -| Name | Type | Description | -| :-------- | :---------------------------------------------- | :------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `options` | [`EventOptions`](../interfaces/EventOptions.md) | event filter options | #### Returns @@ -466,9 +466,9 @@ It returns the events matching a given filter #### Defined in -[src/events/SubgraphEvent.ts:85](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/SubgraphEvent.ts#L85) +[src/events/SubgraphEvent.ts:85](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/SubgraphEvent.ts#L85) ---- +___ ### once @@ -478,11 +478,11 @@ Subscribes to a contract event and waits for the first event to happen #### Parameters -| Name | Type | Default value | Description | -| :--------- | :------------------------------------------------------------------------ | :------------ | :------------------------------------------- | -| `callback` | (`events`: [`EventResult`](../code-reference.md#eventresult)[]) => `void` | `undefined` | function called when the event is triggered | -| `options` | [`EventOptions`](../interfaces/EventOptions.md) | `undefined` | event filter options | -| `timeout` | `number` | `15_000` | maximum time to wait for the event to happen | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `callback` | (`events`: [`EventResult`](../code-reference.md#eventresult)[]) => `void` | `undefined` | function called when the event is triggered | +| `options` | [`EventOptions`](../interfaces/EventOptions.md) | `undefined` | event filter options | +| `timeout` | `number` | `15_000` | maximum time to wait for the event to happen | #### Returns @@ -496,9 +496,9 @@ Promise with the event data #### Defined in -[src/events/NeverminedEvent.ts:60](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/NeverminedEvent.ts#L60) +[src/events/NeverminedEvent.ts:60](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/NeverminedEvent.ts#L60) ---- +___ ### setInstanceConfig @@ -506,8 +506,8 @@ Promise with the event data #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -520,9 +520,9 @@ Promise with the event data #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### subscribe @@ -532,10 +532,10 @@ Subscribes to a contract event #### Parameters -| Name | Type | Description | -| :--------- | :------------------------------------------------------------------------ | :------------------------------------------ | +| Name | Type | Description | +| :------ | :------ | :------ | | `callback` | (`events`: [`EventResult`](../code-reference.md#eventresult)[]) => `void` | function called when the event is triggered | -| `options` | [`EventOptions`](../interfaces/EventOptions.md) | event filter options | +| `options` | [`EventOptions`](../interfaces/EventOptions.md) | event filter options | #### Returns @@ -549,9 +549,9 @@ Subscribes to a contract event #### Defined in -[src/events/NeverminedEvent.ts:38](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/NeverminedEvent.ts#L38) +[src/events/NeverminedEvent.ts:38](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/NeverminedEvent.ts#L38) ---- +___ ### getInstance @@ -561,12 +561,12 @@ It gets a new instance of SubgraphEvent #### Parameters -| Name | Type | Description | -| :------------- | :---------------------------------------------- | :--------------------------------- | -| `contract` | [`ContractBase`](ContractBase.md) | contract instance | -| `eventEmitter` | [`EventEmitter`](../interfaces/EventEmitter.md) | events emitter implementation | -| `graphHttpUri` | `string` | url of the subgraph | -| `networkName` | `string` | the name of the blockchain network | +| Name | Type | Description | +| :------ | :------ | :------ | +| `contract` | [`ContractBase`](ContractBase.md) | contract instance | +| `eventEmitter` | [`EventEmitter`](../interfaces/EventEmitter.md) | events emitter implementation | +| `graphHttpUri` | `string` | url of the subgraph | +| `networkName` | `string` | the name of the blockchain network | #### Returns @@ -580,9 +580,9 @@ the SubgraphEvent instance #### Defined in -[src/events/SubgraphEvent.ts:30](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/events/SubgraphEvent.ts#L30) +[src/events/SubgraphEvent.ts:30](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/events/SubgraphEvent.ts#L30) ---- +___ ### setInstanceConfig @@ -590,15 +590,15 @@ the SubgraphEvent instance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -611,4 +611,4 @@ the SubgraphEvent instance #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/SubscribableObserver.md b/docs/nevermined-sdk/api-reference/classes/SubscribableObserver.md index eaf29e5572..5cf71226f7 100644 --- a/docs/nevermined-sdk/api-reference/classes/SubscribableObserver.md +++ b/docs/nevermined-sdk/api-reference/classes/SubscribableObserver.md @@ -5,9 +5,9 @@ ## Type parameters | Name | -| :--- | -| `T` | -| `P` | +| :------ | +| `T` | +| `P` | ## Table of contents @@ -38,9 +38,9 @@ #### Type parameters | Name | -| :--- | -| `T` | -| `P` | +| :------ | +| `T` | +| `P` | #### Returns @@ -54,17 +54,17 @@ #### Defined in -[src/utils/SubscribableObserver.ts:2](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/SubscribableObserver.ts#L2) +[src/utils/SubscribableObserver.ts:2](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/SubscribableObserver.ts#L2) ---- +___ ### subscriptions -• `Private` **subscriptions**: `Set`\<\{ `onComplete?`: (`complete`: `P`) => `void` ; `onError?`: (`error`: `any`) => `void` ; `onNext?`: (`next`: `T`) => `void` }\> +• `Private` **subscriptions**: `Set`\<\{ `onComplete?`: (`complete`: `P`) => `void` ; `onError?`: (`error`: `any`) => `void` ; `onNext?`: (`next`: `T`) => `void` }\> #### Defined in -[src/utils/SubscribableObserver.ts:4](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/SubscribableObserver.ts#L4) +[src/utils/SubscribableObserver.ts:4](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/SubscribableObserver.ts#L4) ## Methods @@ -74,9 +74,9 @@ #### Parameters -| Name | Type | -| :--------- | :--- | -| `resolve?` | `P` | +| Name | Type | +| :------ | :------ | +| `resolve?` | `P` | #### Returns @@ -84,9 +84,9 @@ #### Defined in -[src/utils/SubscribableObserver.ts:30](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/SubscribableObserver.ts#L30) +[src/utils/SubscribableObserver.ts:30](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/SubscribableObserver.ts#L30) ---- +___ ### emit @@ -94,10 +94,10 @@ #### Parameters -| Name | Type | -| :------ | :------------------------------------------ | -| `type` | `"onNext"` \| `"onComplete"` \| `"onError"` | -| `value` | `any` | +| Name | Type | +| :------ | :------ | +| `type` | ``"onNext"`` \| ``"onComplete"`` \| ``"onError"`` | +| `value` | `any` | #### Returns @@ -105,9 +105,9 @@ #### Defined in -[src/utils/SubscribableObserver.ts:40](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/SubscribableObserver.ts#L40) +[src/utils/SubscribableObserver.ts:40](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/SubscribableObserver.ts#L40) ---- +___ ### error @@ -115,8 +115,8 @@ #### Parameters -| Name | Type | -| :------- | :---- | +| Name | Type | +| :------ | :------ | | `error?` | `any` | #### Returns @@ -125,9 +125,9 @@ #### Defined in -[src/utils/SubscribableObserver.ts:35](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/SubscribableObserver.ts#L35) +[src/utils/SubscribableObserver.ts:35](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/SubscribableObserver.ts#L35) ---- +___ ### next @@ -135,9 +135,9 @@ #### Parameters -| Name | Type | -| :------ | :--- | -| `next?` | `T` | +| Name | Type | +| :------ | :------ | +| `next?` | `T` | #### Returns @@ -145,9 +145,9 @@ #### Defined in -[src/utils/SubscribableObserver.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/SubscribableObserver.ts#L26) +[src/utils/SubscribableObserver.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/SubscribableObserver.ts#L26) ---- +___ ### subscribe @@ -155,25 +155,25 @@ #### Parameters -| Name | Type | -| :------------ | :-------------------------- | -| `onNext?` | (`next`: `T`) => `void` | +| Name | Type | +| :------ | :------ | +| `onNext?` | (`next`: `T`) => `void` | | `onComplete?` | (`complete`: `P`) => `void` | -| `onError?` | (`error`: `any`) => `void` | +| `onError?` | (`error`: `any`) => `void` | #### Returns `Object` -| Name | Type | -| :------------ | :-------------- | +| Name | Type | +| :------ | :------ | | `unsubscribe` | () => `boolean` | #### Defined in -[src/utils/SubscribableObserver.ts:10](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/SubscribableObserver.ts#L10) +[src/utils/SubscribableObserver.ts:10](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/SubscribableObserver.ts#L10) ---- +___ ### unsubscribe @@ -185,4 +185,4 @@ #### Defined in -[src/utils/SubscribableObserver.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/SubscribableObserver.ts#L47) +[src/utils/SubscribableObserver.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/SubscribableObserver.ts#L47) diff --git a/docs/nevermined-sdk/api-reference/classes/SubscribablePromise.md b/docs/nevermined-sdk/api-reference/classes/SubscribablePromise.md index 99d2f8159f..a99176ee6e 100644 --- a/docs/nevermined-sdk/api-reference/classes/SubscribablePromise.md +++ b/docs/nevermined-sdk/api-reference/classes/SubscribablePromise.md @@ -5,9 +5,9 @@ ## Type parameters | Name | -| :--- | -| `T` | -| `P` | +| :------ | +| `T` | +| `P` | ## Table of contents @@ -38,14 +38,14 @@ #### Type parameters | Name | -| :--- | -| `T` | -| `P` | +| :------ | +| `T` | +| `P` | #### Parameters -| Name | Type | -| :--------- | :-------------------------------------------------------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `executor` | (`observer`: [`SubscribableObserver`](SubscribableObserver.md)\<`T`, `P`\>) => `void` \| `Promise`\<`P`\> | #### Returns @@ -54,7 +54,7 @@ #### Defined in -[src/utils/SubscribablePromise.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/SubscribablePromise.ts#L15) +[src/utils/SubscribablePromise.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/SubscribablePromise.ts#L15) ## Properties @@ -64,9 +64,9 @@ #### Defined in -[src/utils/SubscribablePromise.ts:4](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/SubscribablePromise.ts#L4) +[src/utils/SubscribablePromise.ts:4](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/SubscribablePromise.ts#L4) ---- +___ ### promise @@ -74,7 +74,7 @@ #### Defined in -[src/utils/SubscribablePromise.ts:6](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/SubscribablePromise.ts#L6) +[src/utils/SubscribablePromise.ts:6](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/SubscribablePromise.ts#L6) ## Methods @@ -84,8 +84,8 @@ #### Parameters -| Name | Type | -| :------------ | :------------------------ | +| Name | Type | +| :------ | :------ | | `onrejected?` | (`error`: `any`) => `any` | #### Returns @@ -94,9 +94,9 @@ #### Defined in -[src/utils/SubscribablePromise.ts:33](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/SubscribablePromise.ts#L33) +[src/utils/SubscribablePromise.ts:33](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/SubscribablePromise.ts#L33) ---- +___ ### finally @@ -104,8 +104,8 @@ #### Parameters -| Name | Type | -| :----------- | :---------- | +| Name | Type | +| :------ | :------ | | `onfinally?` | () => `any` | #### Returns @@ -114,9 +114,9 @@ #### Defined in -[src/utils/SubscribablePromise.ts:37](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/SubscribablePromise.ts#L37) +[src/utils/SubscribablePromise.ts:37](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/SubscribablePromise.ts#L37) ---- +___ ### init @@ -124,8 +124,8 @@ #### Parameters -| Name | Type | -| :--------- | :-------------------------------------------------------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `executor` | (`observer`: [`SubscribableObserver`](SubscribableObserver.md)\<`T`, `P`\>) => `void` \| `Promise`\<`P`\> | #### Returns @@ -134,9 +134,9 @@ #### Defined in -[src/utils/SubscribablePromise.ts:41](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/SubscribablePromise.ts#L41) +[src/utils/SubscribablePromise.ts:41](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/SubscribablePromise.ts#L41) ---- +___ ### next @@ -144,8 +144,8 @@ #### Parameters -| Name | Type | -| :------- | :---------------------- | +| Name | Type | +| :------ | :------ | | `onNext` | (`next`: `T`) => `void` | #### Returns @@ -154,9 +154,9 @@ #### Defined in -[src/utils/SubscribablePromise.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/SubscribablePromise.ts#L24) +[src/utils/SubscribablePromise.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/SubscribablePromise.ts#L24) ---- +___ ### subscribe @@ -164,23 +164,23 @@ #### Parameters -| Name | Type | -| :------- | :---------------------- | +| Name | Type | +| :------ | :------ | | `onNext` | (`next`: `T`) => `void` | #### Returns `Object` -| Name | Type | -| :------------ | :-------------- | +| Name | Type | +| :------ | :------ | | `unsubscribe` | () => `boolean` | #### Defined in -[src/utils/SubscribablePromise.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/SubscribablePromise.ts#L20) +[src/utils/SubscribablePromise.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/SubscribablePromise.ts#L20) ---- +___ ### then @@ -188,10 +188,10 @@ #### Parameters -| Name | Type | -| :------------- | :------------------------ | -| `onfulfilled?` | (`value`: `P`) => `any` | -| `onrejected?` | (`error`: `any`) => `any` | +| Name | Type | +| :------ | :------ | +| `onfulfilled?` | (`value`: `P`) => `any` | +| `onrejected?` | (`error`: `any`) => `any` | #### Returns @@ -199,4 +199,4 @@ #### Defined in -[src/utils/SubscribablePromise.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/SubscribablePromise.ts#L29) +[src/utils/SubscribablePromise.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/SubscribablePromise.ts#L29) diff --git a/docs/nevermined-sdk/api-reference/classes/SubscriptionCreditsNFTApi.md b/docs/nevermined-sdk/api-reference/classes/SubscriptionCreditsNFTApi.md index 108561ba7d..b0f6efa449 100644 --- a/docs/nevermined-sdk/api-reference/classes/SubscriptionCreditsNFTApi.md +++ b/docs/nevermined-sdk/api-reference/classes/SubscriptionCreditsNFTApi.md @@ -102,9 +102,9 @@ Allows the interaction with external ERC-1155 NFT contracts built on top of the #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L26) +[src/nevermined/api/nfts/NFT1155Api.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L26) ---- +___ ### servicePlugin @@ -120,7 +120,7 @@ Allows the interaction with external ERC-1155 NFT contracts built on top of the #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L39) +[src/nevermined/api/RegistryBaseApi.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L39) ## Accessors @@ -142,9 +142,9 @@ NFT1155Api.address #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:64](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L64) +[src/nevermined/api/nfts/NFT1155Api.ts:64](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L64) ---- +___ ### artifactsFolder @@ -160,9 +160,9 @@ NFT1155Api.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -178,9 +178,9 @@ NFT1155Api.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -196,9 +196,9 @@ NFT1155Api.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -214,9 +214,9 @@ NFT1155Api.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### getContract @@ -236,9 +236,9 @@ NFT1155Api.getContract #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:72](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L72) +[src/nevermined/api/nfts/NFT1155Api.ts:72](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L72) ---- +___ ### instanceConfig @@ -254,9 +254,9 @@ NFT1155Api.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -272,9 +272,9 @@ NFT1155Api.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -290,9 +290,9 @@ NFT1155Api.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -308,9 +308,9 @@ NFT1155Api.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -320,69 +320,69 @@ NFT1155Api.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -390,9 +390,9 @@ NFT1155Api.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -402,38 +402,38 @@ NFT1155Api.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -441,26 +441,26 @@ NFT1155Api.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods ### \_details -▸ **\_details**(`did`, `ercType`): `Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> +▸ **_details**(`did`, `ercType`): `Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> Get the details of an NFT #### Parameters -| Name | Type | Description | -| :-------- | :------------------------------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `ercType` | [`ERCType`](../enums/ERCType.md) | The type of NFT used | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `ercType` | [`ERCType`](../enums/ERCType.md) | The type of NFT used | #### Returns -`Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> +`Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> The details of the NFT. @@ -480,13 +480,13 @@ assert.equal(details.owner, artist.getId()) #### Inherited from -[NFT1155Api](NFT1155Api.md).[\_details](NFT1155Api.md#_details) +[NFT1155Api](NFT1155Api.md).[_details](NFT1155Api.md#_details) #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:152](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L152) +[src/nevermined/api/nfts/NFTsBaseApi.ts:152](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L152) ---- +___ ### access @@ -496,16 +496,16 @@ Access the files associated with an NFT. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------------------------------ | -| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The user account holding NFTs (after purchase) requesting the access | -| `destination?` | `string` | `undefined` | The download destination for the files. | -| `fileIndex?` | `number` | `undefined` | The index of the file. If unset will download all the files in the asset. | -| `agreementId` | `string` | `'0x'` | The NFT sales agreement id. | -| `buyer?` | `string` | `undefined` | Key which represent the buyer | -| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | - | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service reference to use. By default is nft-access. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The user account holding NFTs (after purchase) requesting the access | +| `destination?` | `string` | `undefined` | The download destination for the files. | +| `fileIndex?` | `number` | `undefined` | The index of the file. If unset will download all the files in the asset. | +| `agreementId` | `string` | `'0x'` | The NFT sales agreement id. | +| `buyer?` | `string` | `undefined` | Key which represent the buyer | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | - | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service reference to use. By default is nft-access. | #### Returns @@ -530,9 +530,9 @@ const result = await nevermined.nfts1155.access(ddo.id, collector, '/tmp/') #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:427](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L427) +[src/nevermined/api/nfts/NFTsBaseApi.ts:427](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L427) ---- +___ ### addRating @@ -542,14 +542,14 @@ Given a DID, it adds a vote to the asset curation information. #### Parameters -| Name | Type | Default value | Description | -| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `newRating` | `number` | `undefined` | New average rating of the asset | -| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `newRating` | `number` | `undefined` | New average rating of the asset | +| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -563,9 +563,9 @@ Given a DID, it adds a vote to the asset curation information. #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:534](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L534) +[src/nevermined/api/RegistryBaseApi.ts:534](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L534) ---- +___ ### balance @@ -575,10 +575,10 @@ Get the NFT balance for a particular did associated to an account/address #### Parameters -| Name | Type | Description | -| :-------- | :---------------------------------------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `account` | `string` \| [`NvmAccount`](NvmAccount.md) | The account/address to check the balance of. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `account` | `string` \| [`NvmAccount`](NvmAccount.md) | The account/address to check the balance of. | #### Returns @@ -598,9 +598,9 @@ const balance = await nevermined.nfts1155.balance(ddo.id, artist) #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:464](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L464) +[src/nevermined/api/nfts/NFT1155Api.ts:464](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L464) ---- +___ ### burn @@ -610,12 +610,12 @@ It burns NFTs associated with an asset. #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :---------------------------------------------------------------- | -| `tokenId` | `string` | The Decentralized Identifier of the NFT asset. | -| `nftAmount` | `bigint` | The amount of NFTs to burn. | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the publisher of the NFT with permissions to burn. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `tokenId` | `string` | The Decentralized Identifier of the NFT asset. | +| `nftAmount` | `bigint` | The amount of NFTs to burn. | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the publisher of the NFT with permissions to burn. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -630,7 +630,11 @@ The publisher can only burn NFTs that it owns. NFTs that were already transferre **`Example`** ```ts -await nevermined.nfts1155.burn(did, 2n, artist) +await nevermined.nfts1155.burn( + did, + 2n, + artist +) ``` #### Inherited from @@ -639,9 +643,9 @@ await nevermined.nfts1155.burn(did, 2n, artist) #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:189](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L189) +[src/nevermined/api/nfts/NFT1155Api.ts:189](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L189) ---- +___ ### burnFromHolder @@ -651,13 +655,13 @@ Burns NFTs associated with an asset of a specific account. #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :---------------------------------------------- | -| `holder` | `string` | The address of the account that holds the NFTs. | -| `tokenId` | `string` | The TokenId of the NFT | -| `nftAmount` | `bigint` | The amount of NFTs to burn. | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the publisher of the NFT. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `holder` | `string` | The address of the account that holds the NFTs. | +| `tokenId` | `string` | The TokenId of the NFT | +| `nftAmount` | `bigint` | The amount of NFTs to burn. | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the publisher of the NFT. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -672,7 +676,12 @@ The publisher can only burn NFTs of an account if is an operator. NFTs that were **`Example`** ```ts -await nevermined.nfts1155.burnTo(holder, tokenId, 2n, artist) +await nevermined.nfts1155.burnTo( + holder, + tokenId, + 2n, + artist +) ``` #### Inherited from @@ -681,9 +690,9 @@ await nevermined.nfts1155.burnTo(holder, tokenId, 2n, artist) #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:217](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L217) +[src/nevermined/api/nfts/NFT1155Api.ts:217](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L217) ---- +___ ### buySecondaryMarketNft @@ -693,13 +702,13 @@ Buys a number of listed NFTs on secondary markets. #### Parameters -| Name | Type | Description | -| :------------------ | :---------------------------------------------- | :--------------------------------------------------------- | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the buyer/consumer. | -| `nftAmount` | `bigint` | The number of assets to buy. 1 by default. | -| `agreementIdSeed` | `string` | The seed of the initial sales agreement created off-chain. | -| `conditionsTimeout` | `number`[] | The timeout for the conditions. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the buyer/consumer. | +| `nftAmount` | `bigint` | The number of assets to buy. 1 by default. | +| `agreementIdSeed` | `string` | The seed of the initial sales agreement created off-chain. | +| `conditionsTimeout` | `number`[] | The timeout for the conditions. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -710,7 +719,11 @@ true if the buy was successful. **`Example`** ```ts -const result = await nevermined.nfts1155.buySecondaryMarketNft(collector, 1n, agreementId) +const result = await nevermined.nfts1155.buySecondaryMarketNft( + collector, + 1n, + agreementId + ) ``` **`Throws`** @@ -724,9 +737,9 @@ Thrown if there is an error buying the NFT. #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:345](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L345) +[src/nevermined/api/nfts/NFTsBaseApi.ts:345](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L345) ---- +___ ### claim @@ -736,14 +749,14 @@ Claims the transfer of a NFT to the Nevermined Node on behalf of the publisher. #### Parameters -| Name | Type | Description | -| :--------------- | :------- | :---------------------------------------------------------------------------- | -| `agreementId` | `string` | The NFT sales agreement id. | -| `nftHolder` | `string` | The address of the current owner of the NFT. | -| `nftReceiver` | `string` | The address where the NFT should be transferred. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | The NFT sales agreement id. | +| `nftHolder` | `string` | The address of the current owner of the NFT. | +| `nftReceiver` | `string` | The address where the NFT should be transferred. | | `numberEditions` | `bigint` | The number of NFT editions to transfer. If the NFT is ERC-1155 it should be 1 | -| `did?` | `string` | The Decentralized Identifier of the asset. | -| `serviceIndex?` | `number` | The index of the service in the DDO that will be claimed | +| `did?` | `string` | The Decentralized Identifier of the asset. | +| `serviceIndex?` | `number` | The index of the service in the DDO that will be claimed | #### Returns @@ -764,12 +777,12 @@ as soon as the payment is made ```ts const receipt = await nevermined.nfts1155.claim( - agreementId, - publisherAddress, - subscriberAddress, - 1n, - did, -) + agreementId, + publisherAddress, + subscriberAddress, + 1n, + did + ) ``` #### Inherited from @@ -778,9 +791,9 @@ const receipt = await nevermined.nfts1155.claim( #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:320](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L320) +[src/nevermined/api/nfts/NFT1155Api.ts:320](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L320) ---- +___ ### claimNFT @@ -790,15 +803,15 @@ Claims the transfer of a NFT to the Nevermined Node on behalf of the publisher. #### Parameters -| Name | Type | Default value | Description | -| :--------------- | :------------------------------- | :------------ | :--------------------------------------------------------------------------- | -| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | -| `nftHolder` | `string` | `undefined` | The address of the current owner of the NFT. | -| `nftReceiver` | `string` | `undefined` | The address where the NFT should be transferred. | -| `numberEditions` | `bigint` | `undefined` | The number of NFT editions to transfer. If the NFT is ERC-721 it should be 1 | -| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The Type of the NFT ERC (1155 or 721). | -| `did?` | `string` | `undefined` | The DID of the asset. | -| `serviceIndex?` | `number` | `undefined` | The index of the service in the DDO that will be claimed | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `nftHolder` | `string` | `undefined` | The address of the current owner of the NFT. | +| `nftReceiver` | `string` | `undefined` | The address where the NFT should be transferred. | +| `numberEditions` | `bigint` | `undefined` | The number of NFT editions to transfer. If the NFT is ERC-721 it should be 1 | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The Type of the NFT ERC (1155 or 721). | +| `did?` | `string` | `undefined` | The DID of the asset. | +| `serviceIndex?` | `number` | `undefined` | The index of the service in the DDO that will be claimed | #### Returns @@ -819,12 +832,12 @@ as soon as the payment is made ```ts const receipt = await nevermined.nfts721.claim( - agreementId, - editor.getId(), - subscriber.getId(), - nftAmount, - 721, -) + agreementId, + editor.getId(), + subscriber.getId(), + nftAmount, + 721 + ) ``` **`Throws`** @@ -837,9 +850,9 @@ const receipt = await nevermined.nfts721.claim( #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L52) +[src/nevermined/api/nfts/NFTsBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L52) ---- +___ ### create @@ -849,12 +862,12 @@ Creates a new Nevermined asset associated to a NFT (ERC-1155). #### Parameters -| Name | Type | Description | -| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | -| `nftAttributes` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-1155) associated to the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | +| Name | Type | Description | +| :------ | :------ | :------ | +| `nftAttributes` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-1155) associated to the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | | `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -866,19 +879,22 @@ The newly registered [DDO](DDO.md). ```ts const assetAttributes = AssetAttributes.getInstance({ - metadata, - price: assetPrice, - serviceTypes: ['nft-sales', 'nft-access'], -}) + metadata, + price: assetPrice, + serviceTypes: ['nft-sales', 'nft-access'] + }) const nftAttributes = NFTAttributes.getNFT1155Instance({ - ...assetAttributes, - nftContractAddress: nftUpgradeable.address, - cap: cappedAmount, - amount: numberNFTs, - royaltyAttributes, - preMint, -}) -const ddo = await nevermined.nfts1155.create(nftAttributes, publisher) + ...assetAttributes, + nftContractAddress: nftUpgradeable.address, + cap: cappedAmount, + amount: numberNFTs, + royaltyAttributes, + preMint + }) +const ddo = await nevermined.nfts1155.create( + nftAttributes, + publisher + ) ``` **`See`** @@ -891,25 +907,25 @@ const ddo = await nevermined.nfts1155.create(nftAttributes, publisher) #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:107](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L107) +[src/nevermined/api/nfts/NFT1155Api.ts:107](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L107) ---- +___ ### details -▸ **details**(`did`): `Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> +▸ **details**(`did`): `Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> Get the details of a NFT #### Parameters -| Name | Type | Description | -| :---- | :------- | :--------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `did` | `string` | The Decentralized Identifier of the NFT asset. | #### Returns -`Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> +`Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> The details of the NFT. @@ -933,9 +949,9 @@ assert.equal(details.owner, artist.getId()) #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:676](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L676) +[src/nevermined/api/nfts/NFT1155Api.ts:676](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L676) ---- +___ ### getSubscriptionToken @@ -945,10 +961,10 @@ Get a JWT token for an asset associated with a webService #### Parameters -| Name | Type | Description | -| :----- | :---------------------------- | :----------------------------------------------------------------------------- | -| `did` | `string` | The did of the asset with a webService resource and an associated subscription | -| `from` | [`NvmAccount`](NvmAccount.md) | Account of the user requesting the token | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The did of the asset with a webService resource and an associated subscription | +| `from` | [`NvmAccount`](NvmAccount.md) | Account of the user requesting the token | #### Returns @@ -971,9 +987,9 @@ assert.isDefined(response.neverminedProxyUri) #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:490](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L490) +[src/nevermined/api/nfts/NFTsBaseApi.ts:490](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L490) ---- +___ ### grantOperatorRole @@ -984,11 +1000,11 @@ Granting and revoking minting permissions only can be done by the NFT Contract o #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :--------------------------------------------------------------------- | -| `operatorAddress` | `string` | The address of the account to be added as operator in the NFT Contract | -| `from` | [`NvmAccount`](NvmAccount.md) | The account giving operator permissions | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | The address of the account to be added as operator in the NFT Contract | +| `from` | [`NvmAccount`](NvmAccount.md) | The account giving operator permissions | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -999,7 +1015,10 @@ The TransactionReceipt **`Example`** ```ts -await nevermined.nfts1155.grantOperatorRole(someoneElse, artist) +await nevermined.nfts1155.grantOperatorRole( + someoneElse, + artist +) ``` #### Inherited from @@ -1008,9 +1027,9 @@ await nevermined.nfts1155.grantOperatorRole(someoneElse, artist) #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:622](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L622) +[src/nevermined/api/nfts/NFT1155Api.ts:622](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L622) ---- +___ ### isApprovedForAll @@ -1020,10 +1039,10 @@ Returns if the `operatorAddress` is approved #### Parameters -| Name | Type | Description | -| :---------------- | :------- | :--------------------------------------------------------------------------------------- | -| `operatorAddress` | `string` | The address to check the permissions | -| `from` | `string` | The address of the account granting or revoking the permissions via `setApprovalForAll`. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | The address to check the permissions | +| `from` | `string` | The address of the account granting or revoking the permissions via `setApprovalForAll`. | #### Returns @@ -1047,9 +1066,9 @@ await nevermined.nfts1155.isApprovedForAll(someoneElse, artist.getId()) #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:538](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L538) +[src/nevermined/api/nfts/NFT1155Api.ts:538](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L538) ---- +___ ### isOperator @@ -1059,11 +1078,11 @@ Check if a particular address is the operator of given a NFT address. #### Parameters -| Name | Type | Default value | Description | -| :------------------- | :------------------------------- | :------------ | :-------------------------------------- | -| `nftContractAddress` | `string` | `undefined` | The DID of the NFT to check | -| `operatorAddress` | `string` | `undefined` | The address to check if operator status | -| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `nftContractAddress` | `string` | `undefined` | The DID of the NFT to check | +| `operatorAddress` | `string` | `undefined` | The address to check if operator status | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | #### Returns @@ -1077,9 +1096,9 @@ operator status of address as a boolean #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:118](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L118) +[src/nevermined/api/nfts/NFTsBaseApi.ts:118](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L118) ---- +___ ### isOperatorOfDID @@ -1089,11 +1108,11 @@ Check if a particular address is the operator of a DID. #### Parameters -| Name | Type | Default value | Description | -| :-------- | :------------------------------- | :------------ | :-------------------------------------- | -| `did` | `string` | `undefined` | The DID of the NFT to check | -| `address` | `string` | `undefined` | The address to check if operator status | -| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | The DID of the NFT to check | +| `address` | `string` | `undefined` | The address to check if operator status | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | #### Returns @@ -1107,9 +1126,9 @@ operator status of address as a boolean #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:93](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L93) +[src/nevermined/api/nfts/NFTsBaseApi.ts:93](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L93) ---- +___ ### list @@ -1120,13 +1139,13 @@ In a Nevermined environment, when an asset is unlisted, it is not possible to be #### Parameters -| Name | Type | Default value | Description | -| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -1140,9 +1159,9 @@ In a Nevermined environment, when an asset is unlisted, it is not possible to be #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:482](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L482) +[src/nevermined/api/RegistryBaseApi.ts:482](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L482) ---- +___ ### listOnSecondaryMarkets @@ -1152,15 +1171,15 @@ After purchase re-list an NFT to enable secondary market sales. #### Parameters -| Name | Type | Description | -| :------------ | :---------------------------- | :----------------------------------------------------------- | -| `ddo` | [`DDO`](DDO.md) | The DDO of the asset. | -| `assetPrice` | [`AssetPrice`](AssetPrice.md) | The current setup of asset rewards. | -| `nftAmount` | `bigint` | The number of NFTs put up for secondary sale. | -| `nftTransfer` | `boolean` | - | -| `provider` | `string` | The address that will be the provider of the secondary sale. | -| `token` | [`Token`](Token.md) | - | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the current owner. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | The DDO of the asset. | +| `assetPrice` | [`AssetPrice`](AssetPrice.md) | The current setup of asset rewards. | +| `nftAmount` | `bigint` | The number of NFTs put up for secondary sale. | +| `nftTransfer` | `boolean` | - | +| `provider` | `string` | The address that will be the provider of the secondary sale. | +| `token` | [`Token`](Token.md) | - | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the current owner. | #### Returns @@ -1172,13 +1191,13 @@ the agreementId of the secondary sale. ```ts const agreementId = await nevermined.nfts1155.listOnSecondaryMarkets( - ddo, - assetPrice, - numberNFTs, - collector.getId(), - token, - collector.getId(), -) + ddo, + assetPrice, + numberNFTs, + collector.getId(), + token, + collector.getId() + ) ``` **`Throws`** @@ -1192,9 +1211,9 @@ Thrown if there is an error listing the NFT. #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:262](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L262) +[src/nevermined/api/nfts/NFTsBaseApi.ts:262](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L262) ---- +___ ### mint @@ -1204,14 +1223,14 @@ It mints the NFTs associated with an asset. #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :-------------------------------------------------------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `nftAmount` | `bigint` | The amount of NFTs to mint. | -| `receiver` | `undefined` \| `string` | Account address of the NFT receiver, if `undefined` the minter account will receive the NFT/s | -| `from` | [`NvmAccount`](NvmAccount.md) | The account minting the NFT. \* | -| `data?` | `string` | Data | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `nftAmount` | `bigint` | The amount of NFTs to mint. | +| `receiver` | `undefined` \| `string` | Account address of the NFT receiver, if `undefined` the minter account will receive the NFT/s | +| `from` | [`NvmAccount`](NvmAccount.md) | The account minting the NFT. * | +| `data?` | `string` | Data | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -1226,7 +1245,11 @@ This function can be called multiple times as long as the minting does not excee **`Example`** ```ts -await nevermined.nfts1155.mint(did, 10n, artist) +await nevermined.nfts1155.mint( + did, + 10n, + artist +) ``` #### Inherited from @@ -1235,9 +1258,9 @@ await nevermined.nfts1155.mint(did, 10n, artist) #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L149) +[src/nevermined/api/nfts/NFT1155Api.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L149) ---- +___ ### order @@ -1247,13 +1270,13 @@ It orders NFTs. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------ | :------------------------------------------------------------- | -| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | -| `numberEditions` | `bigint` | `undefined` | The amount of NFTs to buy. | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account of the NFT buyer. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | +| `numberEditions` | `bigint` | `undefined` | The amount of NFTs to buy. | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account of the NFT buyer. | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to order | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | #### Returns @@ -1278,9 +1301,9 @@ agreementId = await nevermined.nfts1155.order(ddo.id, numberNFTs, collector) #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:250](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L250) +[src/nevermined/api/nfts/NFT1155Api.ts:250](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L250) ---- +___ ### orderAsset @@ -1291,12 +1314,12 @@ then sends the request to the publisher via the service endpoint (Node http serv #### Parameters -| Name | Type | Description | -| :----------------- | :------------------------------------------------------------ | :--------------------- | -| `did` | `string` | Decentralized ID. | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | -| `from` | [`NvmAccount`](NvmAccount.md) | Consumer account. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | Decentralized ID. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `from` | [`NvmAccount`](NvmAccount.md) | Consumer account. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -1310,9 +1333,9 @@ The agreement ID. #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:585](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L585) +[src/nevermined/api/RegistryBaseApi.ts:585](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L585) ---- +___ ### owner @@ -1329,7 +1352,9 @@ Address of the contract owner **`Example`** ```ts -const nftContractOwner = new NvmAccount(await nevermined.nfts1155.owner()) +const nftContractOwner = new NvmAccount( + await nevermined.nfts1155.owner() +) ``` #### Inherited from @@ -1338,9 +1363,9 @@ const nftContractOwner = new NvmAccount(await nevermined.nfts1155.owner()) #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:483](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L483) +[src/nevermined/api/nfts/NFT1155Api.ts:483](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L483) ---- +___ ### registerNeverminedAsset @@ -1351,13 +1376,13 @@ via the Nevermined APIs directly. It must accessed via the `assets`, `compute`, #### Parameters -| Name | Type | Description | -| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | -| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | +| Name | Type | Description | +| :------ | :------ | :------ | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | | `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -1375,9 +1400,9 @@ The metadata of the asset created (DDO) #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L52) +[src/nevermined/api/RegistryBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L52) ---- +___ ### releaseRewards @@ -1387,14 +1412,14 @@ Release the funds from escrow. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------ | :----------------------------------------------------------------------- | -| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | -| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to release rewards | -| `nftAmount` | `bigint` | `undefined` | The amount of NFTs to transfer. | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The current owner of the NFTs. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | +| `nftAmount` | `bigint` | `undefined` | The amount of NFTs to transfer. | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The current owner of the NFTs. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | #### Returns @@ -1409,7 +1434,12 @@ A publisher is able to release the funds put on escrow by the consumer after tra **`Example`** ```ts -const receipt = await nevermined.nfts1155.releaseRewards(agreementId, ddo.id, numberNFTs, artist) +const receipt = await nevermined.nfts1155.releaseRewards( + agreementId, + ddo.id, + numberNFTs, + artist + ) ``` **`Throws`** @@ -1423,9 +1453,9 @@ Thrown if there is an error releasing the rewards #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:423](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L423) +[src/nevermined/api/nfts/NFT1155Api.ts:423](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L423) ---- +___ ### releaseSecondaryMarketRewards @@ -1435,13 +1465,13 @@ Used to release the secondary market NFT & the locked rewards. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------ | :----------------------------------------------------------------------- | -| `owner` | [`NvmAccount`](NvmAccount.md) | `undefined` | The owner account. | -| `consumer` | [`NvmAccount`](NvmAccount.md) | `undefined` | The consumer account. | -| `agreementIdSeed` | `string` | `undefined` | the Id of the underlying service agreement seed. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `owner` | [`NvmAccount`](NvmAccount.md) | `undefined` | The owner account. | +| `consumer` | [`NvmAccount`](NvmAccount.md) | `undefined` | The consumer account. | +| `agreementIdSeed` | `string` | `undefined` | the Id of the underlying service agreement seed. | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to release rewards | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | #### Returns @@ -1466,9 +1496,9 @@ Thrown if there is an error releasing the rewards. #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:560](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L560) +[src/nevermined/api/nfts/NFT1155Api.ts:560](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L560) ---- +___ ### resolveAsset @@ -1479,9 +1509,9 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Parameters -| Name | Type | Default value | Description | -| :------- | :------------------------------------------------- | :---------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID. | | `policy` | [`DIDResolvePolicy`](../enums/DIDResolvePolicy.md) | `DIDResolvePolicy.MetadataAPIFirst` | It specifies the resolve policy to apply. It allows to select that priorities during the asset resolution via Metadata API or Immutable URLs (IPFS, Filecoin, etc) | #### Returns @@ -1496,9 +1526,9 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:324](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L324) +[src/nevermined/api/RegistryBaseApi.ts:324](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L324) ---- +___ ### revokeOperatorRole @@ -1509,11 +1539,11 @@ Granting and revoking minting permissions only can be done by the NFT Contract o #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :----------------------------------------------------------------------- | -| `operatorAddress` | `string` | The address of the account to be revoked as operator in the NFT Contract | -| `from` | [`NvmAccount`](NvmAccount.md) | The account revoking operator permissions | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | The address of the account to be revoked as operator in the NFT Contract | +| `from` | [`NvmAccount`](NvmAccount.md) | The account revoking operator permissions | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -1524,7 +1554,10 @@ The TransactionReceipt **`Example`** ```ts -await nevermined.nfts1155.revokeOperatorRole(someoneElse, artist) +await nevermined.nfts1155.revokeOperatorRole( + someoneElse, + artist +) ``` #### Inherited from @@ -1533,9 +1566,9 @@ await nevermined.nfts1155.revokeOperatorRole(someoneElse, artist) #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:648](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L648) +[src/nevermined/api/nfts/NFT1155Api.ts:648](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L648) ---- +___ ### setApprovalForAll @@ -1545,12 +1578,12 @@ Enable or disable NFT permissions for an operator. #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :------------------------------------------------------------------- | -| `operatorAddress` | `string` | The address that of the operator we want to give transfer rights to. | -| `approved` | `boolean` | Give or remove transfer rights from the operator. | -| `from` | [`NvmAccount`](NvmAccount.md) | The account that wants to give transfer rights to the operator. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | The address that of the operator we want to give transfer rights to. | +| `approved` | `boolean` | Give or remove transfer rights from the operator. | +| `from` | [`NvmAccount`](NvmAccount.md) | The account that wants to give transfer rights to the operator. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | #### Returns @@ -1565,7 +1598,11 @@ The TransactionReceipt **`Example`** ```ts -await nevermined.nfts1155.setApprovalForAll(someoneElse, true, artist) +await nevermined.nfts1155.setApprovalForAll( + someoneElse, + true, + artist +) ``` #### Inherited from @@ -1574,9 +1611,9 @@ await nevermined.nfts1155.setApprovalForAll(someoneElse, true, artist) #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:508](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L508) +[src/nevermined/api/nfts/NFT1155Api.ts:508](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L508) ---- +___ ### setInstanceConfig @@ -1584,8 +1621,8 @@ await nevermined.nfts1155.setApprovalForAll(someoneElse, true, artist) #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1598,9 +1635,9 @@ await nevermined.nfts1155.setApprovalForAll(someoneElse, true, artist) #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### transfer @@ -1610,14 +1647,14 @@ Transfer NFTs to the consumer. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------ | :---------------------------------------------------------------- | -| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | -| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | -| `nftAmount` | `bigint` | `undefined` | The number of NFTs to transfer. | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The current owner of the NFTs. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | +| `nftAmount` | `bigint` | `undefined` | The number of NFTs to transfer. | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The current owner of the NFTs. | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to transfer | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | #### Returns @@ -1633,7 +1670,12 @@ execute the transfer in order to be able to release the rewards. **`Example`** ```ts -const receipt = await nevermined.nfts1155.transfer(agreementId, ddo.id, numberNFTs, artist) +const receipt = await nevermined.nfts1155.transfer( + agreementId, + ddo.id, + numberNFTs, + artist + ) ``` **`Throws`** @@ -1647,9 +1689,9 @@ Thrown if there is an error transferring the NFT #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:367](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L367) +[src/nevermined/api/nfts/NFT1155Api.ts:367](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L367) ---- +___ ### updateAsset @@ -1659,13 +1701,13 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Parameters -| Name | Type | Default value | Description | -| :----------------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -1679,9 +1721,9 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:367](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L367) +[src/nevermined/api/RegistryBaseApi.ts:367](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L367) ---- +___ ### deployInstance @@ -1691,12 +1733,12 @@ It deploys a new instance of the Subscription NFT (ERC-1155) contract #### Parameters -| Name | Type | Default value | Description | -| :------------ | :------------------------------------------ | :------------ | :--------------------------------------------------------------- | -| `config` | [`NeverminedOptions`](NeverminedOptions.md) | `undefined` | The Nevermined config | -| `contractABI` | `any` | `undefined` | The ABI of the Subscription NFT Contract | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account that will deploy the contract | -| `args` | `never`[] | `[]` | The list of arguments passed to the contract when is initialized | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `config` | [`NeverminedOptions`](NeverminedOptions.md) | `undefined` | The Nevermined config | +| `contractABI` | `any` | `undefined` | The ABI of the Subscription NFT Contract | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account that will deploy the contract | +| `args` | `never`[] | `[]` | The list of arguments passed to the contract when is initialized | #### Returns @@ -1706,9 +1748,9 @@ The Subscription NFT API instance [SubscriptionCreditsNFTApi](SubscriptionCredit #### Defined in -[src/nevermined/api/nfts/SubscriptionCreditsNFTApi.ts:45](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/SubscriptionCreditsNFTApi.ts#L45) +[src/nevermined/api/nfts/SubscriptionCreditsNFTApi.ts:45](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/SubscriptionCreditsNFTApi.ts#L45) ---- +___ ### getInstance @@ -1718,11 +1760,11 @@ Create a new Nevermined NFTs (ERC-1155) instance allowing to interact with that #### Parameters -| Name | Type | Description | -| :--------------------- | :---------------------------------------------------------- | :---------------------------------------------------------------------------------- | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | The Nevermined config | -| `nftContractInstance?` | [`Nft1155Contract`](Nft1155Contract.md) | If there is already deployed an instance of `Nft1155Contract` | -| `nftContractAddress?` | `string` | If the `Nft1155Contract` is deployed in an address it will connect to that contract | +| Name | Type | Description | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | The Nevermined config | +| `nftContractInstance?` | [`Nft1155Contract`](Nft1155Contract.md) | If there is already deployed an instance of `Nft1155Contract` | +| `nftContractAddress?` | `string` | If the `Nft1155Contract` is deployed in an address it will connect to that contract | #### Returns @@ -1733,7 +1775,10 @@ The NFTs 1155 API instance [NFT1155Api](NFT1155Api.md). **`Example`** ```ts -nfts1155 = await Nft1155Api.getInstance(instanceConfig, nft1155Contract) +nfts1155 = await Nft1155Api.getInstance( + instanceConfig, + nft1155Contract +) ``` #### Inherited from @@ -1742,9 +1787,9 @@ nfts1155 = await Nft1155Api.getInstance(instanceConfig, nft1155Contract) #### Defined in -[src/nevermined/api/nfts/NFT1155Api.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT1155Api.ts#L44) +[src/nevermined/api/nfts/NFT1155Api.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT1155Api.ts#L44) ---- +___ ### getInstanceUsingABI @@ -1754,11 +1799,11 @@ It gets a Subscription NFT (ERC-1155) instance #### Parameters -| Name | Type | Description | -| :------------------- | :---------------------------------------------------------- | :------------------------------------------------------------------------------------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | The Nevermined config | -| `nftContractAddress` | `string` | If the Subscription NFT Contract is deployed in an address it will connect to that contract | -| `solidityABI` | `any` | The ABI of the Contract | +| Name | Type | Description | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | The Nevermined config | +| `nftContractAddress` | `string` | If the Subscription NFT Contract is deployed in an address it will connect to that contract | +| `solidityABI` | `any` | The ABI of the Contract | #### Returns @@ -1768,9 +1813,9 @@ The Subscription NFT API instance [SubscriptionCreditsNFTApi](SubscriptionCredit #### Defined in -[src/nevermined/api/nfts/SubscriptionCreditsNFTApi.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/SubscriptionCreditsNFTApi.ts#L20) +[src/nevermined/api/nfts/SubscriptionCreditsNFTApi.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/SubscriptionCreditsNFTApi.ts#L20) ---- +___ ### getNFTContractAddress @@ -1780,9 +1825,9 @@ Gets the NFT contract address associated with a Nevermined asset from the DDO. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------ | -| `ddo` | [`DDO`](DDO.md) | `undefined` | The DDO of the asset. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | `undefined` | The DDO of the asset. | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service type to look for the contract address | #### Returns @@ -1803,9 +1848,9 @@ const nftContractAddress = NFT1155Api.getNFTContractAddress(ddo) #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:221](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L221) +[src/nevermined/api/nfts/NFTsBaseApi.ts:221](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L221) ---- +___ ### getServicePlugin @@ -1815,8 +1860,8 @@ Initializes the default Nevermined service plugins and return that instance #### Parameters -| Name | Type | Description | -| :------- | :---------------------------------------------------------- | :---------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Nevermined config | #### Returns @@ -1825,12 +1870,12 @@ Initializes the default Nevermined service plugins and return that instance The Nevermined Service Plugin instance -| Name | Type | -| :----------- | :-------------------------------------------------------------------- | -| `access` | [`AccessService`](AccessService.md) | -| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | -| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | -| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | +| Name | Type | +| :------ | :------ | +| `access` | [`AccessService`](AccessService.md) | +| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | +| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | +| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | #### Inherited from @@ -1838,9 +1883,9 @@ The Nevermined Service Plugin instance #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:640](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L640) +[src/nevermined/api/RegistryBaseApi.ts:640](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L640) ---- +___ ### setInstanceConfig @@ -1848,15 +1893,15 @@ The Nevermined Service Plugin instance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1869,4 +1914,4 @@ The Nevermined Service Plugin instance #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/SubscriptionNFTApi.md b/docs/nevermined-sdk/api-reference/classes/SubscriptionNFTApi.md index 78c8bb85f2..9d54d7628c 100644 --- a/docs/nevermined-sdk/api-reference/classes/SubscriptionNFTApi.md +++ b/docs/nevermined-sdk/api-reference/classes/SubscriptionNFTApi.md @@ -105,9 +105,9 @@ Allows the interaction with external ERC-721 NFT contracts built on top of the N #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:27](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L27) +[src/nevermined/api/nfts/NFT721Api.ts:27](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L27) ---- +___ ### servicePlugin @@ -123,7 +123,7 @@ Allows the interaction with external ERC-721 NFT contracts built on top of the N #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L39) +[src/nevermined/api/RegistryBaseApi.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L39) ## Accessors @@ -145,9 +145,9 @@ NFT721Api.address #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:60](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L60) +[src/nevermined/api/nfts/NFT721Api.ts:60](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L60) ---- +___ ### artifactsFolder @@ -163,9 +163,9 @@ NFT721Api.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -181,9 +181,9 @@ NFT721Api.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -199,9 +199,9 @@ NFT721Api.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -217,9 +217,9 @@ NFT721Api.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### getContract @@ -239,9 +239,9 @@ NFT721Api.getContract #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:68](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L68) +[src/nevermined/api/nfts/NFT721Api.ts:68](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L68) ---- +___ ### instanceConfig @@ -257,9 +257,9 @@ NFT721Api.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -275,9 +275,9 @@ NFT721Api.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -293,9 +293,9 @@ NFT721Api.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -311,9 +311,9 @@ NFT721Api.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -323,69 +323,69 @@ NFT721Api.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -393,9 +393,9 @@ NFT721Api.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -405,38 +405,38 @@ NFT721Api.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -444,26 +444,26 @@ NFT721Api.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods ### \_details -▸ **\_details**(`did`, `ercType`): `Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> +▸ **_details**(`did`, `ercType`): `Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> Get the details of an NFT #### Parameters -| Name | Type | Description | -| :-------- | :------------------------------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `ercType` | [`ERCType`](../enums/ERCType.md) | The type of NFT used | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `ercType` | [`ERCType`](../enums/ERCType.md) | The type of NFT used | #### Returns -`Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> +`Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> The details of the NFT. @@ -483,13 +483,13 @@ assert.equal(details.owner, artist.getId()) #### Inherited from -[NFT721Api](NFT721Api.md).[\_details](NFT721Api.md#_details) +[NFT721Api](NFT721Api.md).[_details](NFT721Api.md#_details) #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:152](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L152) +[src/nevermined/api/nfts/NFTsBaseApi.ts:152](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L152) ---- +___ ### access @@ -499,16 +499,16 @@ Access the files associated with an NFT. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------------------------------ | -| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The user account holding NFTs (after purchase) requesting the access | -| `destination?` | `string` | `undefined` | The download destination for the files. | -| `fileIndex?` | `number` | `undefined` | The index of the file. If unset will download all the files in the asset. | -| `agreementId` | `string` | `'0x'` | The NFT sales agreement id. | -| `buyer?` | `string` | `undefined` | Key which represent the buyer | -| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | - | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service reference to use. By default is nft-access. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The user account holding NFTs (after purchase) requesting the access | +| `destination?` | `string` | `undefined` | The download destination for the files. | +| `fileIndex?` | `number` | `undefined` | The index of the file. If unset will download all the files in the asset. | +| `agreementId` | `string` | `'0x'` | The NFT sales agreement id. | +| `buyer?` | `string` | `undefined` | Key which represent the buyer | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | - | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service reference to use. By default is nft-access. | #### Returns @@ -533,9 +533,9 @@ const result = await nevermined.nfts1155.access(ddo.id, collector, '/tmp/') #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:427](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L427) +[src/nevermined/api/nfts/NFTsBaseApi.ts:427](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L427) ---- +___ ### addRating @@ -545,14 +545,14 @@ Given a DID, it adds a vote to the asset curation information. #### Parameters -| Name | Type | Default value | Description | -| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `newRating` | `number` | `undefined` | New average rating of the asset | -| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `newRating` | `number` | `undefined` | New average rating of the asset | +| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -566,9 +566,9 @@ Given a DID, it adds a vote to the asset curation information. #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:534](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L534) +[src/nevermined/api/RegistryBaseApi.ts:534](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L534) ---- +___ ### balanceOf @@ -578,8 +578,8 @@ Get the NFT balance for a particular account/address #### Parameters -| Name | Type | Description | -| :-------- | :---------------------------------------- | :------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `account` | `string` \| [`NvmAccount`](NvmAccount.md) | The account/address to check the balance of. | #### Returns @@ -600,9 +600,9 @@ const balance = await nevermined.nfts721.balance(artist) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:506](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L506) +[src/nevermined/api/nfts/NFT721Api.ts:506](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L506) ---- +___ ### burn @@ -612,11 +612,11 @@ Burn NFTs associated with an asset. #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :--------------------------------------- | -| `tokenId` | `string` | The identifier of the token to burn | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the publisher of the NFT. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `tokenId` | `string` | The identifier of the token to burn | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the publisher of the NFT. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -631,7 +631,10 @@ The publisher can only burn NFTs that it owns. NFTs that were already transferre **`Example`** ```ts -await nevermined.nfts721.burn(tokenId, artist) +await nevermined.nfts721.burn( + tokenId, + artist +) ``` #### Inherited from @@ -640,9 +643,9 @@ await nevermined.nfts721.burn(tokenId, artist) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:348](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L348) +[src/nevermined/api/nfts/NFT721Api.ts:348](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L348) ---- +___ ### buySecondaryMarketNft @@ -652,13 +655,13 @@ Buys a number of listed NFTs on secondary markets. #### Parameters -| Name | Type | Description | -| :------------------ | :---------------------------------------------- | :--------------------------------------------------------- | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the buyer/consumer. | -| `nftAmount` | `bigint` | The number of assets to buy. 1 by default. | -| `agreementIdSeed` | `string` | The seed of the initial sales agreement created off-chain. | -| `conditionsTimeout` | `number`[] | The timeout for the conditions. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the buyer/consumer. | +| `nftAmount` | `bigint` | The number of assets to buy. 1 by default. | +| `agreementIdSeed` | `string` | The seed of the initial sales agreement created off-chain. | +| `conditionsTimeout` | `number`[] | The timeout for the conditions. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -669,7 +672,11 @@ true if the buy was successful. **`Example`** ```ts -const result = await nevermined.nfts1155.buySecondaryMarketNft(collector, 1n, agreementId) +const result = await nevermined.nfts1155.buySecondaryMarketNft( + collector, + 1n, + agreementId + ) ``` **`Throws`** @@ -683,9 +690,9 @@ Thrown if there is an error buying the NFT. #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:345](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L345) +[src/nevermined/api/nfts/NFTsBaseApi.ts:345](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L345) ---- +___ ### claim @@ -695,13 +702,13 @@ Claims the transfer of a NFT to the Nevermined Node on behalf of the publisher. #### Parameters -| Name | Type | Description | -| :-------------- | :------- | :------------------------------------------------------- | -| `agreementId` | `string` | The NFT sales agreement id. | -| `nftHolder` | `string` | The address of the current owner of the NFT. | -| `nftReceiver` | `string` | The address where the NFT should be transferred. | -| `did?` | `string` | The Decentralized Identifier of the asset. | -| `serviceIndex?` | `any` | The index of the service in the DDO that will be claimed | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | The NFT sales agreement id. | +| `nftHolder` | `string` | The address of the current owner of the NFT. | +| `nftReceiver` | `string` | The address where the NFT should be transferred. | +| `did?` | `string` | The Decentralized Identifier of the asset. | +| `serviceIndex?` | `any` | The index of the service in the DDO that will be claimed | #### Returns @@ -721,7 +728,11 @@ as soon as the payment is made **`Example`** ```ts -const receipt = await nevermined.nfts721.claim(agreementId, editor.getId(), subscriber.getId()) +const receipt = await nevermined.nfts721.claim( + agreementId, + editor.getId(), + subscriber.getId() + ) ``` #### Inherited from @@ -730,9 +741,9 @@ const receipt = await nevermined.nfts721.claim(agreementId, editor.getId(), subs #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:198](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L198) +[src/nevermined/api/nfts/NFT721Api.ts:198](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L198) ---- +___ ### claimNFT @@ -742,15 +753,15 @@ Claims the transfer of a NFT to the Nevermined Node on behalf of the publisher. #### Parameters -| Name | Type | Default value | Description | -| :--------------- | :------------------------------- | :------------ | :--------------------------------------------------------------------------- | -| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | -| `nftHolder` | `string` | `undefined` | The address of the current owner of the NFT. | -| `nftReceiver` | `string` | `undefined` | The address where the NFT should be transferred. | -| `numberEditions` | `bigint` | `undefined` | The number of NFT editions to transfer. If the NFT is ERC-721 it should be 1 | -| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The Type of the NFT ERC (1155 or 721). | -| `did?` | `string` | `undefined` | The DID of the asset. | -| `serviceIndex?` | `number` | `undefined` | The index of the service in the DDO that will be claimed | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `nftHolder` | `string` | `undefined` | The address of the current owner of the NFT. | +| `nftReceiver` | `string` | `undefined` | The address where the NFT should be transferred. | +| `numberEditions` | `bigint` | `undefined` | The number of NFT editions to transfer. If the NFT is ERC-721 it should be 1 | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The Type of the NFT ERC (1155 or 721). | +| `did?` | `string` | `undefined` | The DID of the asset. | +| `serviceIndex?` | `number` | `undefined` | The index of the service in the DDO that will be claimed | #### Returns @@ -771,12 +782,12 @@ as soon as the payment is made ```ts const receipt = await nevermined.nfts721.claim( - agreementId, - editor.getId(), - subscriber.getId(), - nftAmount, - 721, -) + agreementId, + editor.getId(), + subscriber.getId(), + nftAmount, + 721 + ) ``` **`Throws`** @@ -789,9 +800,9 @@ const receipt = await nevermined.nfts721.claim( #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L52) +[src/nevermined/api/nfts/NFTsBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L52) ---- +___ ### create @@ -801,12 +812,12 @@ Creates a new Nevermined asset associated to a NFT (ERC-721). #### Parameters -| Name | Type | Description | -| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | -| `nftAttributes` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | +| Name | Type | Description | +| :------ | :------ | :------ | +| `nftAttributes` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | | `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -845,25 +856,25 @@ ddo = await nevermined.nfts721.create( #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:102](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L102) +[src/nevermined/api/nfts/NFT721Api.ts:102](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L102) ---- +___ ### details -▸ **details**(`did`): `Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> +▸ **details**(`did`): `Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> Get the details of an NFT #### Parameters -| Name | Type | Description | -| :---- | :------- | :--------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `did` | `string` | The Decentralized Identifier of the NFT asset. | #### Returns -`Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> +`Promise`\<\{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> The details of the NFT. @@ -887,9 +898,9 @@ assert.equal(details.owner, artist.getId()) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:638](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L638) +[src/nevermined/api/nfts/NFT721Api.ts:638](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L638) ---- +___ ### getSubscriptionToken @@ -899,10 +910,10 @@ Get a JWT token for an asset associated with a webService #### Parameters -| Name | Type | Description | -| :----- | :---------------------------- | :----------------------------------------------------------------------------- | -| `did` | `string` | The did of the asset with a webService resource and an associated subscription | -| `from` | [`NvmAccount`](NvmAccount.md) | Account of the user requesting the token | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The did of the asset with a webService resource and an associated subscription | +| `from` | [`NvmAccount`](NvmAccount.md) | Account of the user requesting the token | #### Returns @@ -925,9 +936,9 @@ assert.isDefined(response.neverminedProxyUri) #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:490](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L490) +[src/nevermined/api/nfts/NFTsBaseApi.ts:490](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L490) ---- +___ ### grantOperatorRole @@ -938,11 +949,11 @@ Granting and revoking operator permissions only can be done by the NFT Contract #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :--------------------------------------------------------------------- | -| `operatorAddress` | `string` | The address of the account to be added as operator in the NFT Contract | -| `from` | [`NvmAccount`](NvmAccount.md) | The account giving operator permissions | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | The address of the account to be added as operator in the NFT Contract | +| `from` | [`NvmAccount`](NvmAccount.md) | The account giving operator permissions | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -953,7 +964,10 @@ The TransactionReceipt **`Example`** ```ts -await nevermined.nfts721.grantOperatorRole(someoneElse, artist) +await nevermined.nfts721.grantOperatorRole( + someoneElse, + artist +) ``` #### Inherited from @@ -962,9 +976,9 @@ await nevermined.nfts721.grantOperatorRole(someoneElse, artist) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:584](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L584) +[src/nevermined/api/nfts/NFT721Api.ts:584](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L584) ---- +___ ### isApprovedForAll @@ -974,10 +988,10 @@ Returns if the `operatorAddress` is approved #### Parameters -| Name | Type | Description | -| :---------------- | :------- | :--------------------------------------------------------------------------------------- | -| `operatorAddress` | `string` | The address to check the permissions | -| `from` | `string` | The address of the account granting or revoking the permissions via `setApprovalForAll`. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | The address to check the permissions | +| `from` | `string` | The address of the account granting or revoking the permissions via `setApprovalForAll`. | #### Returns @@ -997,9 +1011,9 @@ await nevermined.nfts721.isApprovedForAll(someoneElse, artist.getId()) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:490](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L490) +[src/nevermined/api/nfts/NFT721Api.ts:490](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L490) ---- +___ ### isOperator @@ -1009,11 +1023,11 @@ Check if a particular address is the operator of given a NFT address. #### Parameters -| Name | Type | Default value | Description | -| :------------------- | :------------------------------- | :------------ | :-------------------------------------- | -| `nftContractAddress` | `string` | `undefined` | The DID of the NFT to check | -| `operatorAddress` | `string` | `undefined` | The address to check if operator status | -| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `nftContractAddress` | `string` | `undefined` | The DID of the NFT to check | +| `operatorAddress` | `string` | `undefined` | The address to check if operator status | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | #### Returns @@ -1027,9 +1041,9 @@ operator status of address as a boolean #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:118](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L118) +[src/nevermined/api/nfts/NFTsBaseApi.ts:118](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L118) ---- +___ ### isOperatorOfDID @@ -1039,10 +1053,10 @@ It checks if an address is an operator of the NFT associated to the asset #### Parameters -| Name | Type | Description | -| :-------- | :------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized identifier of the NFT asset. | -| `address` | `string` | The address to check if operator status | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The Decentralized identifier of the NFT asset. | +| `address` | `string` | The address to check if operator status | #### Returns @@ -1056,9 +1070,9 @@ true if the address is an operator of the NFT #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:648](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L648) +[src/nevermined/api/nfts/NFT721Api.ts:648](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L648) ---- +___ ### list @@ -1069,13 +1083,13 @@ In a Nevermined environment, when an asset is unlisted, it is not possible to be #### Parameters -| Name | Type | Default value | Description | -| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -1089,9 +1103,9 @@ In a Nevermined environment, when an asset is unlisted, it is not possible to be #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:482](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L482) +[src/nevermined/api/RegistryBaseApi.ts:482](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L482) ---- +___ ### listOnSecondaryMarkets @@ -1101,15 +1115,15 @@ After purchase re-list an NFT to enable secondary market sales. #### Parameters -| Name | Type | Description | -| :------------ | :---------------------------- | :----------------------------------------------------------- | -| `ddo` | [`DDO`](DDO.md) | The DDO of the asset. | -| `assetPrice` | [`AssetPrice`](AssetPrice.md) | The current setup of asset rewards. | -| `nftAmount` | `bigint` | The number of NFTs put up for secondary sale. | -| `nftTransfer` | `boolean` | - | -| `provider` | `string` | The address that will be the provider of the secondary sale. | -| `token` | [`Token`](Token.md) | - | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the current owner. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | The DDO of the asset. | +| `assetPrice` | [`AssetPrice`](AssetPrice.md) | The current setup of asset rewards. | +| `nftAmount` | `bigint` | The number of NFTs put up for secondary sale. | +| `nftTransfer` | `boolean` | - | +| `provider` | `string` | The address that will be the provider of the secondary sale. | +| `token` | [`Token`](Token.md) | - | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the current owner. | #### Returns @@ -1121,13 +1135,13 @@ the agreementId of the secondary sale. ```ts const agreementId = await nevermined.nfts1155.listOnSecondaryMarkets( - ddo, - assetPrice, - numberNFTs, - collector.getId(), - token, - collector.getId(), -) + ddo, + assetPrice, + numberNFTs, + collector.getId(), + token, + collector.getId() + ) ``` **`Throws`** @@ -1141,9 +1155,9 @@ Thrown if there is an error listing the NFT. #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:262](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L262) +[src/nevermined/api/nfts/NFTsBaseApi.ts:262](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L262) ---- +___ ### mint @@ -1155,11 +1169,11 @@ This function can be called multiple times as long as the minting does not excee #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the minter | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the minter | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -1179,9 +1193,9 @@ await nevermined.nfts721.mint(ddo.id, artist) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:324](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L324) +[src/nevermined/api/nfts/NFT721Api.ts:324](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L324) ---- +___ ### mintWithURL @@ -1193,13 +1207,13 @@ This function can be called multiple times as long as the minting does not excee #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :--------------------------------------------- | -| `to` | `string` | The address receiving the NFT minted | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `url` | `string` | The URL with NFT metadata | -| `from` | [`NvmAccount`](NvmAccount.md) | The account of the minter | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `to` | `string` | The address receiving the NFT minted | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `url` | `string` | The URL with NFT metadata | +| `from` | [`NvmAccount`](NvmAccount.md) | The account of the minter | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -1219,9 +1233,9 @@ await nevermined.nfts721.mintWithURL(receiverAddress, ddo.id, nftMetadata, artis #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:368](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L368) +[src/nevermined/api/nfts/NFT721Api.ts:368](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L368) ---- +___ ### order @@ -1231,12 +1245,12 @@ Order a NFT-721. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------ | :------------------------------------------------------------- | -| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account of the NFT buyer. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account of the NFT buyer. | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to order | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | #### Returns @@ -1261,9 +1275,9 @@ const agreementId = await nevermined.nfts721.order(ddo.id, collector) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:139](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L139) +[src/nevermined/api/nfts/NFT721Api.ts:139](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L139) ---- +___ ### orderAsset @@ -1274,12 +1288,12 @@ then sends the request to the publisher via the service endpoint (Node http serv #### Parameters -| Name | Type | Description | -| :----------------- | :------------------------------------------------------------ | :--------------------- | -| `did` | `string` | Decentralized ID. | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | -| `from` | [`NvmAccount`](NvmAccount.md) | Consumer account. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | Decentralized ID. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `from` | [`NvmAccount`](NvmAccount.md) | Consumer account. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -1293,9 +1307,9 @@ The agreement ID. #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:585](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L585) +[src/nevermined/api/RegistryBaseApi.ts:585](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L585) ---- +___ ### ownerOf @@ -1305,8 +1319,8 @@ Gets the contract owner #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `did` | `string` | #### Returns @@ -1318,7 +1332,9 @@ Address of the contract owner **`Example`** ```ts -const nftContractOwner = new NvmAccount(await nevermined.nfts721.ownerOf()) +const nftContractOwner = new NvmAccount( + await nevermined.nfts721.ownerOf() +) ``` #### Inherited from @@ -1327,9 +1343,9 @@ const nftContractOwner = new NvmAccount(await nevermined.nfts721.ownerOf()) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:417](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L417) +[src/nevermined/api/nfts/NFT721Api.ts:417](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L417) ---- +___ ### ownerOfAsset @@ -1339,8 +1355,8 @@ Given a DID it gets the owner of the NFT if that DID is used as tokenId #### Parameters -| Name | Type | Description | -| :---- | :------- | :--------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `did` | `string` | The Decentralized identifier of the NFT asset. | #### Returns @@ -1361,9 +1377,9 @@ const owner = await nevermined.nfts721.ownerOfAsset(ddo.id, nftTokenAddress) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:451](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L451) +[src/nevermined/api/nfts/NFT721Api.ts:451](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L451) ---- +___ ### ownerOfAssetByAgreement @@ -1373,10 +1389,10 @@ Given a DID and an agreement id it gets the owner of the NFT #### Parameters -| Name | Type | Description | -| :------------ | :------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized identifier of the NFT asset. | -| `agreementId` | `string` | The NFT sales agreement id. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The Decentralized identifier of the NFT asset. | +| `agreementId` | `string` | The NFT sales agreement id. | #### Returns @@ -1396,9 +1412,9 @@ const owner = await nevermined.nfts721.ownerOfAssetByAgreement(ddo.id, agreement #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:468](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L468) +[src/nevermined/api/nfts/NFT721Api.ts:468](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L468) ---- +___ ### ownerOfTokenId @@ -1408,8 +1424,8 @@ Given some information, it gets the public address of the asset owner #### Parameters -| Name | Type | Description | -| :-------- | :------- | :----------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `tokenId` | `string` | The token id | #### Returns @@ -1430,9 +1446,9 @@ const owner = await nevermined.nfts721.ownerOfTokenId(tokenId) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:434](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L434) +[src/nevermined/api/nfts/NFT721Api.ts:434](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L434) ---- +___ ### registerNeverminedAsset @@ -1443,13 +1459,13 @@ via the Nevermined APIs directly. It must accessed via the `assets`, `compute`, #### Parameters -| Name | Type | Description | -| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | -| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | +| Name | Type | Description | +| :------ | :------ | :------ | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | The account publishing the asset | | `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | -| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | #### Returns @@ -1467,9 +1483,9 @@ The metadata of the asset created (DDO) #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L52) +[src/nevermined/api/RegistryBaseApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L52) ---- +___ ### releaseRewards @@ -1479,13 +1495,13 @@ Release the funds from escrow. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------ | :----------------------------------------------------------------------- | -| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | -| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The current owner of the NFTs. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The current owner of the NFTs. | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to release rewards | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | #### Returns @@ -1500,7 +1516,11 @@ A publisher is able to release the funds put on escrow by the consumer after tra **`Example`** ```ts -const receipt = await nevermined.nfts721.releaseRewards(agreementId, ddo.id, artist) +const receipt = await nevermined.nfts721.releaseRewards( + agreementId, + ddo.id, + artist + ) ``` **`Throws`** @@ -1514,9 +1534,9 @@ Thrown if there is an error releasing the rewards. #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:283](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L283) +[src/nevermined/api/nfts/NFT721Api.ts:283](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L283) ---- +___ ### releaseSecondaryMarketRewards @@ -1526,12 +1546,12 @@ Used to release the secondary market NFT & the locked rewards. #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :---------------------------------------------------------------- | -| `owner` | [`NvmAccount`](NvmAccount.md) | The owner account. | -| `account` | [`NvmAccount`](NvmAccount.md) | Account of the user sending the transaction | -| `agreementIdSeed` | `string` | the seed of the Agreement Id of the underlying service agreement. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `owner` | [`NvmAccount`](NvmAccount.md) | The owner account. | +| `account` | [`NvmAccount`](NvmAccount.md) | Account of the user sending the transaction | +| `agreementIdSeed` | `string` | the seed of the Agreement Id of the underlying service agreement. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -1556,9 +1576,9 @@ Thrown if there is an error releasing the rewards. #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:529](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L529) +[src/nevermined/api/nfts/NFT721Api.ts:529](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L529) ---- +___ ### resolveAsset @@ -1569,9 +1589,9 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Parameters -| Name | Type | Default value | Description | -| :------- | :------------------------------------------------- | :---------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID. | | `policy` | [`DIDResolvePolicy`](../enums/DIDResolvePolicy.md) | `DIDResolvePolicy.MetadataAPIFirst` | It specifies the resolve policy to apply. It allows to select that priorities during the asset resolution via Metadata API or Immutable URLs (IPFS, Filecoin, etc) | #### Returns @@ -1586,9 +1606,9 @@ Depending of the resolution policy it prioritize fetching that Metadata from the #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:324](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L324) +[src/nevermined/api/RegistryBaseApi.ts:324](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L324) ---- +___ ### revokeOperatorRole @@ -1599,11 +1619,11 @@ Granting and revoking minting permissions only can be done by the NFT Contract o #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------- | :----------------------------------------------------------------------- | -| `operatorAddress` | `string` | The address of the account to be revoked as operator in the NFT Contract | -| `from` | [`NvmAccount`](NvmAccount.md) | The account revoking operator permissions | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `operatorAddress` | `string` | The address of the account to be revoked as operator in the NFT Contract | +| `from` | [`NvmAccount`](NvmAccount.md) | The account revoking operator permissions | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -1614,7 +1634,10 @@ The TransactionReceipt **`Example`** ```ts -await nevermined.nfts721.revokeOperatorRole(someoneElse, artist) +await nevermined.nfts721.revokeOperatorRole( + someoneElse, + artist +) ``` #### Inherited from @@ -1623,9 +1646,9 @@ await nevermined.nfts721.revokeOperatorRole(someoneElse, artist) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:610](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L610) +[src/nevermined/api/nfts/NFT721Api.ts:610](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L610) ---- +___ ### setApprovalForAll @@ -1635,12 +1658,12 @@ Enable or disable NFT permissions for an operator. #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :------------------------------------------------------------------- | -| `target` | `string` | The address that of the operator we want to give transfer rights to. | -| `approved` | `boolean` | Give or remove transfer rights from the operator. | -| `from` | [`NvmAccount`](NvmAccount.md) | The account that wants to give transfer rights to the operator. | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `target` | `string` | The address that of the operator we want to give transfer rights to. | +| `approved` | `boolean` | Give or remove transfer rights from the operator. | +| `from` | [`NvmAccount`](NvmAccount.md) | The account that wants to give transfer rights to the operator. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | #### Returns @@ -1651,7 +1674,11 @@ The TransactionReceipt **`Example`** ```ts -await nevermined.nfts721.setApprovalForAll(someoneElse, true, artist) +await nevermined.nfts721.setApprovalForAll( + someoneElse, + true, + artist +) ``` #### Inherited from @@ -1660,9 +1687,9 @@ await nevermined.nfts721.setApprovalForAll(someoneElse, true, artist) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:396](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L396) +[src/nevermined/api/nfts/NFT721Api.ts:396](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L396) ---- +___ ### setInstanceConfig @@ -1670,8 +1697,8 @@ await nevermined.nfts721.setApprovalForAll(someoneElse, true, artist) #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1684,9 +1711,9 @@ await nevermined.nfts721.setApprovalForAll(someoneElse, true, artist) #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### transfer @@ -1697,13 +1724,13 @@ This method only will work if called by the owner of the asset or a provider. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------ | :---------------------------------------------------------------- | -| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | -| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The current owner of the NFTs. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The current owner of the NFTs. | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to transfer | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | #### Returns @@ -1733,9 +1760,9 @@ Thrown if there is an error transferring the NFT #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:232](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L232) +[src/nevermined/api/nfts/NFT721Api.ts:232](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L232) ---- +___ ### updateAsset @@ -1745,13 +1772,13 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Parameters -| Name | Type | Default value | Description | -| :----------------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | -| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | -| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | #### Returns @@ -1765,9 +1792,9 @@ Given a DID, updates the metadata associated to the asset. It also can upload th #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:367](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L367) +[src/nevermined/api/RegistryBaseApi.ts:367](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L367) ---- +___ ### deployInstance @@ -1777,12 +1804,12 @@ It deploys a new instance of the Subscription NFT (ERC-721) contract #### Parameters -| Name | Type | Default value | Description | -| :------------ | :------------------------------------------ | :------------ | :--------------------------------------------------------------- | -| `config` | [`NeverminedOptions`](NeverminedOptions.md) | `undefined` | The Nevermined config | -| `contractABI` | `any` | `undefined` | The ABI of the Subscription NFT Contract | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account that will deploy the contract | -| `args` | `never`[] | `[]` | The list of arguments passed to the contract when is initialized | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `config` | [`NeverminedOptions`](NeverminedOptions.md) | `undefined` | The Nevermined config | +| `contractABI` | `any` | `undefined` | The ABI of the Subscription NFT Contract | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | The account that will deploy the contract | +| `args` | `never`[] | `[]` | The list of arguments passed to the contract when is initialized | #### Returns @@ -1792,9 +1819,9 @@ The Subscription NFT API instance [SubscriptionNFTApi](SubscriptionNFTApi.md). #### Defined in -[src/nevermined/api/nfts/SubscriptionNFTApi.ts:45](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/SubscriptionNFTApi.ts#L45) +[src/nevermined/api/nfts/SubscriptionNFTApi.ts:45](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/SubscriptionNFTApi.ts#L45) ---- +___ ### getInstance @@ -1804,10 +1831,10 @@ Create a new Nevermined NFTs (ERC-721) instance allowing to interact with that k #### Parameters -| Name | Type | Description | -| :------------------- | :---------------------------------------------------------- | :-------------------------------------------------------------------------------- | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | The Nevermined config | -| `nftContractAddress` | `string` | If the Nft721 Contract is deployed in an address it will connect to that contract | +| Name | Type | Description | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | The Nevermined config | +| `nftContractAddress` | `string` | If the Nft721 Contract is deployed in an address it will connect to that contract | #### Returns @@ -1818,7 +1845,10 @@ The NFTs 721 API instance [NFT721Api](NFT721Api.md). **`Example`** ```ts -nfts721 = await Nft721Api.getInstance(instanceConfig, nftContractAddress) +nfts721 = await Nft721Api.getInstance( + instanceConfig, + nftContractAddress +) ``` #### Inherited from @@ -1827,9 +1857,9 @@ nfts721 = await Nft721Api.getInstance(instanceConfig, nftContractAddress) #### Defined in -[src/nevermined/api/nfts/NFT721Api.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFT721Api.ts#L44) +[src/nevermined/api/nfts/NFT721Api.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFT721Api.ts#L44) ---- +___ ### getInstanceUsingABI @@ -1839,11 +1869,11 @@ It gets a Subscription NFT (ERC-721) instance #### Parameters -| Name | Type | Description | -| :------------------- | :---------------------------------------------------------- | :------------------------------------------------------------------------------------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | The Nevermined config | -| `nftContractAddress` | `string` | If the Subscription NFT Contract is deployed in an address it will connect to that contract | -| `solidityABI` | `any` | The ABI of the Contract | +| Name | Type | Description | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | The Nevermined config | +| `nftContractAddress` | `string` | If the Subscription NFT Contract is deployed in an address it will connect to that contract | +| `solidityABI` | `any` | The ABI of the Contract | #### Returns @@ -1853,9 +1883,9 @@ The Subscription NFT API instance [SubscriptionNFTApi](SubscriptionNFTApi.md). #### Defined in -[src/nevermined/api/nfts/SubscriptionNFTApi.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/SubscriptionNFTApi.ts#L20) +[src/nevermined/api/nfts/SubscriptionNFTApi.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/SubscriptionNFTApi.ts#L20) ---- +___ ### getNFTContractAddress @@ -1865,9 +1895,9 @@ Gets the NFT contract address associated with a Nevermined asset from the DDO. #### Parameters -| Name | Type | Default value | Description | -| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------ | -| `ddo` | [`DDO`](DDO.md) | `undefined` | The DDO of the asset. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `ddo` | [`DDO`](DDO.md) | `undefined` | The DDO of the asset. | | `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service type to look for the contract address | #### Returns @@ -1888,9 +1918,9 @@ const nftContractAddress = NFT1155Api.getNFTContractAddress(ddo) #### Defined in -[src/nevermined/api/nfts/NFTsBaseApi.ts:221](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/nfts/NFTsBaseApi.ts#L221) +[src/nevermined/api/nfts/NFTsBaseApi.ts:221](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/nfts/NFTsBaseApi.ts#L221) ---- +___ ### getServicePlugin @@ -1900,8 +1930,8 @@ Initializes the default Nevermined service plugins and return that instance #### Parameters -| Name | Type | Description | -| :------- | :---------------------------------------------------------- | :---------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Nevermined config | #### Returns @@ -1910,12 +1940,12 @@ Initializes the default Nevermined service plugins and return that instance The Nevermined Service Plugin instance -| Name | Type | -| :----------- | :-------------------------------------------------------------------- | -| `access` | [`AccessService`](AccessService.md) | -| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | -| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | -| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | +| Name | Type | +| :------ | :------ | +| `access` | [`AccessService`](AccessService.md) | +| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | +| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | +| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | #### Inherited from @@ -1923,9 +1953,9 @@ The Nevermined Service Plugin instance #### Defined in -[src/nevermined/api/RegistryBaseApi.ts:640](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/RegistryBaseApi.ts#L640) +[src/nevermined/api/RegistryBaseApi.ts:640](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/RegistryBaseApi.ts#L640) ---- +___ ### setInstanceConfig @@ -1933,15 +1963,15 @@ The Nevermined Service Plugin instance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1954,4 +1984,4 @@ The Nevermined Service Plugin instance #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/TemplateStoreManager.md b/docs/nevermined-sdk/api-reference/classes/TemplateStoreManager.md index 372fe88b60..405cf801bc 100644 --- a/docs/nevermined-sdk/api-reference/classes/TemplateStoreManager.md +++ b/docs/nevermined-sdk/api-reference/classes/TemplateStoreManager.md @@ -63,8 +63,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -77,7 +77,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -91,9 +91,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -105,9 +105,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -119,9 +119,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -133,9 +133,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -147,7 +147,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -165,9 +165,9 @@ ContractBase.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -183,9 +183,9 @@ ContractBase.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -201,9 +201,9 @@ ContractBase.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -219,9 +219,9 @@ ContractBase.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -237,9 +237,9 @@ ContractBase.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -255,9 +255,9 @@ ContractBase.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -273,9 +273,9 @@ ContractBase.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -291,9 +291,9 @@ ContractBase.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -303,69 +303,69 @@ ContractBase.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -373,9 +373,9 @@ ContractBase.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -385,38 +385,38 @@ ContractBase.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -424,7 +424,7 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -434,12 +434,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :---------------- | :---------------------------------------------- | -| `address` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `ignoreApproved?` | `boolean` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `address` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `ignoreApproved?` | `boolean` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -447,9 +447,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/TemplateStoreManager.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/TemplateStoreManager.ts#L51) +[src/keeper/contracts/managers/TemplateStoreManager.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/TemplateStoreManager.ts#L51) ---- +___ ### call @@ -458,16 +458,16 @@ ContractBase.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -479,9 +479,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### getFromAddress @@ -489,8 +489,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -503,9 +503,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getListSize @@ -517,9 +517,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/TemplateStoreManager.ts:86](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/TemplateStoreManager.ts#L86) +[src/keeper/contracts/managers/TemplateStoreManager.ts:86](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/TemplateStoreManager.ts#L86) ---- +___ ### getOwner @@ -531,9 +531,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/TemplateStoreManager.ts:30](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/TemplateStoreManager.ts#L30) +[src/keeper/contracts/managers/TemplateStoreManager.ts:30](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/TemplateStoreManager.ts#L30) ---- +___ ### getTemplate @@ -541,8 +541,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :----------- | :------- | +| Name | Type | +| :------ | :------ | | `templateId` | `string` | #### Returns @@ -551,24 +551,24 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/TemplateStoreManager.ts:72](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/TemplateStoreManager.ts#L72) +[src/keeper/contracts/managers/TemplateStoreManager.ts:72](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/TemplateStoreManager.ts#L72) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -576,9 +576,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -586,11 +586,11 @@ ContractBase.walletClient #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -602,9 +602,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### isApproved @@ -612,8 +612,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :----------- | :------- | +| Name | Type | +| :------ | :------ | | `templateId` | `string` | #### Returns @@ -622,9 +622,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/TemplateStoreManager.ts:82](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/TemplateStoreManager.ts#L82) +[src/keeper/contracts/managers/TemplateStoreManager.ts:82](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/TemplateStoreManager.ts#L82) ---- +___ ### proposeTemplate @@ -632,12 +632,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :-------------- | :---------------------------------------------- | -| `address` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `ignoreExists?` | `boolean` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `address` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `ignoreExists?` | `boolean` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -645,9 +645,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/TemplateStoreManager.ts:34](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/TemplateStoreManager.ts#L34) +[src/keeper/contracts/managers/TemplateStoreManager.ts:34](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/TemplateStoreManager.ts#L34) ---- +___ ### revokeTemplate @@ -655,10 +655,10 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :---------- | :---------------------------------------------- | -| `address` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `address` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | | `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -667,9 +667,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/TemplateStoreManager.ts:68](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/TemplateStoreManager.ts#L68) +[src/keeper/contracts/managers/TemplateStoreManager.ts:68](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/TemplateStoreManager.ts#L68) ---- +___ ### send @@ -677,12 +677,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -694,9 +694,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -704,12 +704,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -721,9 +721,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -731,8 +731,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -745,9 +745,9 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -755,8 +755,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -769,9 +769,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -779,8 +779,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -793,9 +793,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/managers/TemplateStoreManager.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/TemplateStoreManager.ts#L22) +[src/keeper/contracts/managers/TemplateStoreManager.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/TemplateStoreManager.ts#L22) ---- +___ ### setInstanceConfig @@ -803,15 +803,15 @@ ContractBase.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -824,4 +824,4 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/Token.md b/docs/nevermined-sdk/api-reference/classes/Token.md index 8bf5f47ae2..f3be46c19d 100644 --- a/docs/nevermined-sdk/api-reference/classes/Token.md +++ b/docs/nevermined-sdk/api-reference/classes/Token.md @@ -23,7 +23,7 @@ - [contractName](Token.md#contractname) - [events](Token.md#events) - [version](Token.md#version) -- [ERC20_ABI](Token.md#erc20_abi) +- [ERC20\_ABI](Token.md#erc20_abi) ### Accessors @@ -68,8 +68,8 @@ #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -82,7 +82,7 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -96,9 +96,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -110,9 +110,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -124,9 +124,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -138,9 +138,9 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -152,17 +152,17 @@ #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ---- +___ -### ERC20_ABI +### ERC20\_ABI -▪ `Static` **ERC20_ABI**: `string`[] +▪ `Static` **ERC20\_ABI**: `string`[] #### Defined in -[src/keeper/contracts/Token.ts:8](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L8) +[src/keeper/contracts/Token.ts:8](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L8) ## Accessors @@ -180,9 +180,9 @@ ContractBase.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -198,9 +198,9 @@ ContractBase.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -216,9 +216,9 @@ ContractBase.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -234,9 +234,9 @@ ContractBase.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -252,9 +252,9 @@ ContractBase.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -270,9 +270,9 @@ ContractBase.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -288,9 +288,9 @@ ContractBase.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -306,9 +306,9 @@ ContractBase.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -318,69 +318,69 @@ ContractBase.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -388,9 +388,9 @@ ContractBase.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -400,38 +400,38 @@ ContractBase.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -439,7 +439,7 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -449,11 +449,11 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :---------- | :---------------------------------------------- | -| `to` | `string` | -| `price` | `bigint` | -| `from` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `to` | `string` | +| `price` | `bigint` | +| `from` | [`NvmAccount`](NvmAccount.md) | | `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -462,9 +462,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/Token.ts:28](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L28) +[src/keeper/contracts/Token.ts:28](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L28) ---- +___ ### balanceOf @@ -472,8 +472,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `address` | `string` | #### Returns @@ -482,9 +482,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/Token.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L44) +[src/keeper/contracts/Token.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L44) ---- +___ ### balanceOfConverted @@ -492,8 +492,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `address` | `string` | #### Returns @@ -502,9 +502,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/Token.ts:36](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L36) +[src/keeper/contracts/Token.ts:36](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L36) ---- +___ ### call @@ -513,16 +513,16 @@ ContractBase.walletClient #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -534,9 +534,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### decimals @@ -548,9 +548,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/Token.ts:32](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L32) +[src/keeper/contracts/Token.ts:32](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L32) ---- +___ ### getFromAddress @@ -558,8 +558,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -572,24 +572,24 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -597,9 +597,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### init @@ -607,11 +607,11 @@ ContractBase.walletClient #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -623,9 +623,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### name @@ -637,9 +637,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/Token.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L52) +[src/keeper/contracts/Token.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L52) ---- +___ ### send @@ -647,12 +647,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -664,9 +664,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -674,12 +674,12 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -691,9 +691,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -701,8 +701,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -715,9 +715,9 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -725,8 +725,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -739,9 +739,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### strBalanceOf @@ -749,8 +749,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `address` | `string` | #### Returns @@ -759,9 +759,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/Token.ts:40](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L40) +[src/keeper/contracts/Token.ts:40](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L40) ---- +___ ### symbol @@ -773,9 +773,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/Token.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L48) +[src/keeper/contracts/Token.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L48) ---- +___ ### totalSupply @@ -787,9 +787,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/Token.ts:56](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L56) +[src/keeper/contracts/Token.ts:56](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L56) ---- +___ ### transfer @@ -797,11 +797,11 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :---------- | :---------------------------------------------- | -| `to` | `string` | -| `amount` | `bigint` | -| `from` | [`NvmAccount`](NvmAccount.md) | +| Name | Type | +| :------ | :------ | +| `to` | `string` | +| `amount` | `bigint` | +| `from` | [`NvmAccount`](NvmAccount.md) | | `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -810,9 +810,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/Token.ts:60](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L60) +[src/keeper/contracts/Token.ts:60](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L60) ---- +___ ### getInstance @@ -820,8 +820,8 @@ ContractBase.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -834,9 +834,9 @@ ContractBase.walletClient #### Defined in -[src/keeper/contracts/Token.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Token.ts#L22) +[src/keeper/contracts/Token.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Token.ts#L22) ---- +___ ### setInstanceConfig @@ -844,15 +844,15 @@ ContractBase.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -865,4 +865,4 @@ ContractBase.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/TokenUtils.md b/docs/nevermined-sdk/api-reference/classes/TokenUtils.md index fd367d2055..13b60d05a6 100644 --- a/docs/nevermined-sdk/api-reference/classes/TokenUtils.md +++ b/docs/nevermined-sdk/api-reference/classes/TokenUtils.md @@ -49,8 +49,8 @@ Tokens submodule of Nevermined. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -63,7 +63,7 @@ Tokens submodule of Nevermined. #### Defined in -[src/nevermined/Token.ts:9](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Token.ts#L9) +[src/nevermined/Token.ts:9](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Token.ts#L9) ## Accessors @@ -81,9 +81,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -99,9 +99,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -117,9 +117,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -135,9 +135,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -153,9 +153,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -171,9 +171,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -189,9 +189,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -207,9 +207,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -219,69 +219,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -289,9 +289,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -301,38 +301,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -340,7 +340,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -354,9 +354,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/Token.ts:30](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Token.ts#L30) +[src/nevermined/Token.ts:30](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Token.ts#L30) ---- +___ ### getName @@ -370,9 +370,9 @@ Get token name. #### Defined in -[src/nevermined/Token.ts:37](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Token.ts#L37) +[src/nevermined/Token.ts:37](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Token.ts#L37) ---- +___ ### getSymbol @@ -386,9 +386,9 @@ Get token symbol. #### Defined in -[src/nevermined/Token.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Token.ts#L26) +[src/nevermined/Token.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Token.ts#L26) ---- +___ ### getTotalSupply @@ -402,9 +402,9 @@ Get token total supply #### Defined in -[src/nevermined/Token.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Token.ts#L44) +[src/nevermined/Token.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Token.ts#L44) ---- +___ ### request @@ -414,11 +414,11 @@ Request tokens for an account. #### Parameters -| Name | Type | Description | -| :-------- | :---------------------------------------------- | :---------------- | -| `account` | [`NvmAccount`](NvmAccount.md) | Account instance. | -| `amount` | `bigint` | Token amount. | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | [`NvmAccount`](NvmAccount.md) | Account instance. | +| `amount` | `bigint` | Token amount. | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | - | #### Returns @@ -428,9 +428,9 @@ true if the call succeeded, false otherwise #### Defined in -[src/nevermined/Token.ts:73](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Token.ts#L73) +[src/nevermined/Token.ts:73](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Token.ts#L73) ---- +___ ### setInstanceConfig @@ -438,8 +438,8 @@ true if the call succeeded, false otherwise #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -452,9 +452,9 @@ true if the call succeeded, false otherwise #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### transfer @@ -464,12 +464,12 @@ Transfer a number of tokens to the mentioned account. #### Parameters -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :-------------------------------- | -| `to` | `string` | Address that receives the tokens. | -| `amount` | `bigint` | Tokens to transfer. | -| `from` | [`NvmAccount`](NvmAccount.md) | Sender account | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `to` | `string` | Address that receives the tokens. | +| `amount` | `bigint` | Tokens to transfer. | +| `from` | [`NvmAccount`](NvmAccount.md) | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -479,9 +479,9 @@ True if the transfer succeeded. #### Defined in -[src/nevermined/Token.ts:56](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Token.ts#L56) +[src/nevermined/Token.ts:56](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Token.ts#L56) ---- +___ ### getInstance @@ -491,8 +491,8 @@ Returns the instance of Token. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -507,9 +507,9 @@ Returns the instance of Token. #### Defined in -[src/nevermined/Token.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Token.ts#L18) +[src/nevermined/Token.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Token.ts#L18) ---- +___ ### setInstanceConfig @@ -517,15 +517,15 @@ Returns the instance of Token. #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -538,4 +538,4 @@ Returns the instance of Token. #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/TransferDIDOwnershipCondition.md b/docs/nevermined-sdk/api-reference/classes/TransferDIDOwnershipCondition.md index c0bf11c198..53711ae653 100644 --- a/docs/nevermined-sdk/api-reference/classes/TransferDIDOwnershipCondition.md +++ b/docs/nevermined-sdk/api-reference/classes/TransferDIDOwnershipCondition.md @@ -74,8 +74,8 @@ Condition allowing to transfer the ownership between the original owner and a re #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -88,7 +88,7 @@ ProviderCondition\.constructor #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -102,9 +102,9 @@ ProviderCondition.address #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -116,9 +116,9 @@ ProviderCondition.contract #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -130,9 +130,9 @@ ProviderCondition.contractName #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -144,9 +144,9 @@ ProviderCondition.events #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -158,7 +158,7 @@ ProviderCondition.version #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -176,9 +176,9 @@ ProviderCondition.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -194,9 +194,9 @@ ProviderCondition.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -212,9 +212,9 @@ ProviderCondition.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -230,9 +230,9 @@ ProviderCondition.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -248,9 +248,9 @@ ProviderCondition.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -266,9 +266,9 @@ ProviderCondition.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -284,9 +284,9 @@ ProviderCondition.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -302,9 +302,9 @@ ProviderCondition.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -314,69 +314,69 @@ ProviderCondition.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -384,9 +384,9 @@ ProviderCondition.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -396,38 +396,38 @@ ProviderCondition.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -435,7 +435,7 @@ ProviderCondition.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -445,11 +445,11 @@ ProviderCondition.walletClient #### Parameters -| Name | Type | -| :------------ | :---------------------------------------------- | -| `conditionId` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `conditionId` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -461,9 +461,9 @@ ProviderCondition.abortByTimeOut #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L75) +[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L75) ---- +___ ### call @@ -472,16 +472,16 @@ ProviderCondition.abortByTimeOut #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -493,9 +493,9 @@ ProviderCondition.call #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### fulfill @@ -505,13 +505,13 @@ Fulfill the transfer DID ownership condition. #### Parameters -| Name | Type | Description | -| :------------ | :---------------------------------------------- | :----------------------------------------- | -| `agreementId` | `string` | Agreement identifier. | -| `did` | `string` | The Decentralized Identifier of the asset. | -| `receiver` | `string` | The address of the granted user. | -| `from` | [`NvmAccount`](NvmAccount.md) | Account fullfilling | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | +| Name | Type | Description | +| :------ | :------ | :------ | +| `agreementId` | `string` | Agreement identifier. | +| `did` | `string` | The Decentralized Identifier of the asset. | +| `receiver` | `string` | The address of the granted user. | +| `from` | [`NvmAccount`](NvmAccount.md) | Account fullfilling | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -530,9 +530,9 @@ ProviderCondition.fulfill #### Defined in -[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:53](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L53) +[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:53](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L53) ---- +___ ### fulfillInstance @@ -540,13 +540,13 @@ ProviderCondition.fulfill #### Parameters -| Name | Type | Default value | -| :----------------- | :-------------------------------------------------------- | :------------ | -| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -558,9 +558,9 @@ ProviderCondition.fulfillInstance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L139) +[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L139) ---- +___ ### fulfillPlain @@ -568,13 +568,13 @@ ProviderCondition.fulfillInstance #### Parameters -| Name | Type | Default value | -| :------------ | :-------------------------------------------------------- | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -586,9 +586,9 @@ ProviderCondition.fulfillPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L47) +[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L47) ---- +___ ### fulfillWithNode @@ -596,12 +596,12 @@ ProviderCondition.fulfillPlain #### Parameters -| Name | Type | -| :----------------- | :----------------------------------------------------- | -| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | -| `additionalParams` | `Record`\<`string`, `unknown`\> | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | +| `additionalParams` | `Record`\<`string`, `unknown`\> | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -613,9 +613,9 @@ ProviderCondition.fulfillWithNode #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L183) +[src/keeper/contracts/conditions/Condition.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L183) ---- +___ ### generateId @@ -623,10 +623,10 @@ ProviderCondition.fulfillWithNode #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -638,9 +638,9 @@ ProviderCondition.generateId #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L61) +[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L61) ---- +___ ### generateIdHash @@ -648,10 +648,10 @@ ProviderCondition.generateId #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `...values` | `any`[] | +| `...values` | `any`[] | #### Returns @@ -663,9 +663,9 @@ ProviderCondition.generateIdHash #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L57) +[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L57) ---- +___ ### generateIdWithSeed @@ -673,10 +673,10 @@ ProviderCondition.generateIdHash #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -688,9 +688,9 @@ ProviderCondition.generateIdWithSeed #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L65) +[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L65) ---- +___ ### getConditionFulfilledEvent @@ -698,8 +698,8 @@ ProviderCondition.generateIdWithSeed #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns @@ -712,9 +712,9 @@ ProviderCondition.getConditionFulfilledEvent #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L79) +[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L79) ---- +___ ### getFromAddress @@ -722,8 +722,8 @@ ProviderCondition.getConditionFulfilledEvent #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -736,24 +736,24 @@ ProviderCondition.getFromAddress #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -761,9 +761,9 @@ ProviderCondition.getTransactionLogs #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### hashValues @@ -771,8 +771,8 @@ ProviderCondition.getTransactionLogs #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -785,9 +785,9 @@ ProviderCondition.hashValues #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L116) +[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L116) ---- +___ ### hashValuesPlain @@ -795,8 +795,8 @@ ProviderCondition.hashValues #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -809,9 +809,9 @@ ProviderCondition.hashValuesPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L122) +[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L122) ---- +___ ### init @@ -819,11 +819,11 @@ ProviderCondition.hashValuesPlain #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -835,9 +835,9 @@ ProviderCondition.init #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instance @@ -845,10 +845,10 @@ ProviderCondition.init #### Parameters -| Name | Type | -| :------------ | :------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | #### Returns @@ -860,9 +860,9 @@ ProviderCondition.instance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L163) +[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L163) ---- +___ ### instanceFromDDO @@ -870,11 +870,11 @@ ProviderCondition.instance #### Parameters -| Name | Type | -| :------------ | :-------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `AccessConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `ctx` | `AccessConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | #### Returns @@ -886,9 +886,9 @@ ProviderCondition.instanceFromDDO #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L131) +[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L131) ---- +___ ### nodeMethod @@ -904,9 +904,9 @@ ProviderCondition.nodeMethod #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L200) +[src/keeper/contracts/conditions/Condition.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L200) ---- +___ ### params @@ -916,9 +916,9 @@ Generates the hash of the condition inputs. #### Parameters -| Name | Type | Description | -| :--------- | :------- | :----------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the asset. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `did` | `string` | The Decentralized Identifier of the asset. | | `receiver` | `string` | Address of the granted user or the DID provider. | #### Returns @@ -933,9 +933,9 @@ ProviderCondition.params #### Defined in -[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:31](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L31) +[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:31](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L31) ---- +___ ### paramsFromDDO @@ -943,8 +943,8 @@ ProviderCondition.params #### Parameters -| Name | Type | -| :--------------- | :----------------------- | +| Name | Type | +| :------ | :------ | | `«destructured»` | `AccessConditionContext` | #### Returns @@ -957,9 +957,9 @@ ProviderCondition.paramsFromDDO #### Defined in -[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:35](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L35) +[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:35](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L35) ---- +___ ### send @@ -967,12 +967,12 @@ ProviderCondition.paramsFromDDO #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -984,9 +984,9 @@ ProviderCondition.send #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -994,12 +994,12 @@ ProviderCondition.send #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1011,9 +1011,9 @@ ProviderCondition.sendFrom #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -1021,8 +1021,8 @@ ProviderCondition.sendFrom #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1035,9 +1035,9 @@ ProviderCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1045,8 +1045,8 @@ ProviderCondition.setInstanceConfig #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1059,9 +1059,9 @@ ProviderCondition.someLog #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -1069,8 +1069,8 @@ ProviderCondition.someLog #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1083,9 +1083,9 @@ ProviderCondition.getInstance #### Defined in -[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L15) +[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L15) ---- +___ ### setInstanceConfig @@ -1093,15 +1093,15 @@ ProviderCondition.getInstance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1114,4 +1114,4 @@ ProviderCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/TransferNFT721Condition.md b/docs/nevermined-sdk/api-reference/classes/TransferNFT721Condition.md index 04ff0f5d7e..d400a41f90 100644 --- a/docs/nevermined-sdk/api-reference/classes/TransferNFT721Condition.md +++ b/docs/nevermined-sdk/api-reference/classes/TransferNFT721Condition.md @@ -75,8 +75,8 @@ Condition allowing to transfer an NFT between the original owner and a receiver #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -89,7 +89,7 @@ ProviderCondition\.constructor #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -103,9 +103,9 @@ ProviderCondition.address #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -117,9 +117,9 @@ ProviderCondition.contract #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -131,9 +131,9 @@ ProviderCondition.contractName #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -145,9 +145,9 @@ ProviderCondition.events #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -159,7 +159,7 @@ ProviderCondition.version #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ## Accessors @@ -177,9 +177,9 @@ ProviderCondition.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -195,9 +195,9 @@ ProviderCondition.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -213,9 +213,9 @@ ProviderCondition.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -231,9 +231,9 @@ ProviderCondition.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -249,9 +249,9 @@ ProviderCondition.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -267,9 +267,9 @@ ProviderCondition.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -285,9 +285,9 @@ ProviderCondition.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -303,9 +303,9 @@ ProviderCondition.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -315,69 +315,69 @@ ProviderCondition.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -385,9 +385,9 @@ ProviderCondition.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -397,38 +397,38 @@ ProviderCondition.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -436,7 +436,7 @@ ProviderCondition.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -446,11 +446,11 @@ ProviderCondition.walletClient #### Parameters -| Name | Type | -| :------------ | :---------------------------------------------- | -| `conditionId` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `conditionId` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -462,9 +462,9 @@ ProviderCondition.abortByTimeOut #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L75) +[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L75) ---- +___ ### call @@ -473,16 +473,16 @@ ProviderCondition.abortByTimeOut #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -494,9 +494,9 @@ ProviderCondition.call #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### fulfill @@ -506,16 +506,16 @@ Fulfill the transfer NFT condition. #### Parameters -| Name | Type | Default value | Description | -| :--------------------- | :---------------------------------------------- | :------------ | :--------------------------------------------------- | -| `agreementId` | `string` | `undefined` | The agreement identifier. | -| `did` | `string` | `undefined` | The DID of the asset with NFTs. | -| `nftReceiver` | `string` | `undefined` | The address of the account to receive the NFT. | -| `lockPaymentCondition` | `string` | `undefined` | lock payment condition identifier. | -| `nftTokenAddress` | `string` | `undefined` | address of the nft token to use. | -| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | The agreement identifier. | +| `did` | `string` | `undefined` | The DID of the asset with NFTs. | +| `nftReceiver` | `string` | `undefined` | The address of the account to receive the NFT. | +| `lockPaymentCondition` | `string` | `undefined` | lock payment condition identifier. | +| `nftTokenAddress` | `string` | `undefined` | address of the nft token to use. | +| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | #### Returns @@ -533,9 +533,9 @@ ProviderCondition.fulfill #### Defined in -[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:146](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L146) +[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:146](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L146) ---- +___ ### fulfillInstance @@ -543,13 +543,13 @@ ProviderCondition.fulfill #### Parameters -| Name | Type | Default value | -| :----------------- | :-------------------------------------------------------- | :------------ | -| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -561,9 +561,9 @@ ProviderCondition.fulfillInstance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L139) +[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L139) ---- +___ ### fulfillPlain @@ -571,13 +571,13 @@ ProviderCondition.fulfillInstance #### Parameters -| Name | Type | Default value | -| :------------ | :-------------------------------------------------------- | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -589,9 +589,9 @@ ProviderCondition.fulfillPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L47) +[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L47) ---- +___ ### fulfillWithNode @@ -599,12 +599,12 @@ ProviderCondition.fulfillPlain #### Parameters -| Name | Type | -| :----------------- | :----------------------------------------------------- | -| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | -| `additionalParams` | `Record`\<`string`, `unknown`\> | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | +| `additionalParams` | `Record`\<`string`, `unknown`\> | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -616,9 +616,9 @@ ProviderCondition.fulfillWithNode #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L183) +[src/keeper/contracts/conditions/Condition.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L183) ---- +___ ### generateId @@ -626,10 +626,10 @@ ProviderCondition.fulfillWithNode #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -641,9 +641,9 @@ ProviderCondition.generateId #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L61) +[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L61) ---- +___ ### generateIdHash @@ -651,10 +651,10 @@ ProviderCondition.generateId #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `...values` | `any`[] | +| `...values` | `any`[] | #### Returns @@ -666,9 +666,9 @@ ProviderCondition.generateIdHash #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L57) +[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L57) ---- +___ ### generateIdWithSeed @@ -676,10 +676,10 @@ ProviderCondition.generateIdHash #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -691,9 +691,9 @@ ProviderCondition.generateIdWithSeed #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L65) +[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L65) ---- +___ ### getConditionFulfilledEvent @@ -701,8 +701,8 @@ ProviderCondition.generateIdWithSeed #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns @@ -715,9 +715,9 @@ ProviderCondition.getConditionFulfilledEvent #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L79) +[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L79) ---- +___ ### getFromAddress @@ -725,8 +725,8 @@ ProviderCondition.getConditionFulfilledEvent #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -739,24 +739,24 @@ ProviderCondition.getFromAddress #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -764,9 +764,9 @@ ProviderCondition.getTransactionLogs #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### hashValues @@ -774,8 +774,8 @@ ProviderCondition.getTransactionLogs #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -788,9 +788,9 @@ ProviderCondition.hashValues #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L116) +[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L116) ---- +___ ### hashValuesPlain @@ -798,8 +798,8 @@ ProviderCondition.hashValues #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -812,9 +812,9 @@ ProviderCondition.hashValuesPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L122) +[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L122) ---- +___ ### init @@ -822,11 +822,11 @@ ProviderCondition.hashValuesPlain #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -838,9 +838,9 @@ ProviderCondition.init #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instance @@ -848,10 +848,10 @@ ProviderCondition.init #### Parameters -| Name | Type | -| :------------ | :------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | #### Returns @@ -863,9 +863,9 @@ ProviderCondition.instance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L163) +[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L163) ---- +___ ### instanceFromDDO @@ -873,11 +873,11 @@ ProviderCondition.instance #### Parameters -| Name | Type | -| :------------ | :-------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `TransferNFT721ConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `ctx` | `TransferNFT721ConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | #### Returns @@ -889,9 +889,9 @@ ProviderCondition.instanceFromDDO #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L131) +[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L131) ---- +___ ### nodeMethod @@ -907,9 +907,9 @@ ProviderCondition.nodeMethod #### Defined in -[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:171](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L171) +[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:171](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L171) ---- +___ ### params @@ -919,15 +919,15 @@ Generates the hash of condition inputs. #### Parameters -| Name | Type | Default value | Description | -| :------------------ | :-------- | :------------ | :--------------------------------------------------- | -| `did` | `string` | `undefined` | The DID of the asset with NFTs. | -| `nftHolder` | `string` | `undefined` | The address of the Holder of the NFT. | -| `nftReceiver` | `string` | `undefined` | The address of the granted user or the DID provider. | -| `lockCondition` | `string` | `undefined` | Lock condition identifier. | -| `nftTokenAddress` | `string` | `undefined` | The address of the NFT token to use. | -| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | -| `expiration` | `number` | `0` | The expiration time of the condition | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | The DID of the asset with NFTs. | +| `nftHolder` | `string` | `undefined` | The address of the Holder of the NFT. | +| `nftReceiver` | `string` | `undefined` | The address of the granted user or the DID provider. | +| `lockCondition` | `string` | `undefined` | Lock condition identifier. | +| `nftTokenAddress` | `string` | `undefined` | The address of the NFT token to use. | +| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | +| `expiration` | `number` | `0` | The expiration time of the condition | #### Returns @@ -941,9 +941,9 @@ ProviderCondition.params #### Defined in -[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:38](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L38) +[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:38](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L38) ---- +___ ### paramsFromDDO @@ -951,10 +951,10 @@ ProviderCondition.params #### Parameters -| Name | Type | -| :--------------- | :------------------------------- | +| Name | Type | +| :------ | :------ | | `«destructured»` | `TransferNFT721ConditionContext` | -| `lockCondition` | `any` | +| `lockCondition` | `any` | #### Returns @@ -966,9 +966,9 @@ ProviderCondition.paramsFromDDO #### Defined in -[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:83](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L83) +[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:83](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L83) ---- +___ ### paramsFromService @@ -976,10 +976,10 @@ ProviderCondition.paramsFromDDO #### Parameters -| Name | Type | -| :--------------- | :------------------------------- | +| Name | Type | +| :------ | :------ | | `«destructured»` | `TransferNFT721ConditionContext` | -| `lockCondition` | `any` | +| `lockCondition` | `any` | #### Returns @@ -987,9 +987,9 @@ ProviderCondition.paramsFromDDO #### Defined in -[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:107](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L107) +[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:107](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L107) ---- +___ ### send @@ -997,12 +997,12 @@ ProviderCondition.paramsFromDDO #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1014,9 +1014,9 @@ ProviderCondition.send #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -1024,12 +1024,12 @@ ProviderCondition.send #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1041,9 +1041,9 @@ ProviderCondition.sendFrom #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -1051,8 +1051,8 @@ ProviderCondition.sendFrom #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1065,9 +1065,9 @@ ProviderCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1075,8 +1075,8 @@ ProviderCondition.setInstanceConfig #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1089,9 +1089,9 @@ ProviderCondition.someLog #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -1099,8 +1099,8 @@ ProviderCondition.someLog #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1113,9 +1113,9 @@ ProviderCondition.getInstance #### Defined in -[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:23](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L23) +[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:23](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L23) ---- +___ ### setInstanceConfig @@ -1123,15 +1123,15 @@ ProviderCondition.getInstance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1144,4 +1144,4 @@ ProviderCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/TransferNFTCondition.md b/docs/nevermined-sdk/api-reference/classes/TransferNFTCondition.md index 0d8c3cdefa..dcc7b22f4c 100644 --- a/docs/nevermined-sdk/api-reference/classes/TransferNFTCondition.md +++ b/docs/nevermined-sdk/api-reference/classes/TransferNFTCondition.md @@ -23,7 +23,7 @@ Condition allowing to transfer an NFT between the original owner and a receiver - [contractName](TransferNFTCondition.md#contractname) - [events](TransferNFTCondition.md#events) - [version](TransferNFTCondition.md#version) -- [NO_EXPIRY](TransferNFTCondition.md#no_expiry) +- [NO\_EXPIRY](TransferNFTCondition.md#no_expiry) ### Accessors @@ -77,8 +77,8 @@ Condition allowing to transfer an NFT between the original owner and a receiver #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `contractName` | `string` | #### Returns @@ -91,7 +91,7 @@ ProviderCondition\.constructor #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L24) ## Properties @@ -105,9 +105,9 @@ ProviderCondition.address #### Defined in -[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L22) +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L22) ---- +___ ### contract @@ -119,9 +119,9 @@ ProviderCondition.contract #### Defined in -[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L19) +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L19) ---- +___ ### contractName @@ -133,9 +133,9 @@ ProviderCondition.contractName #### Defined in -[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L18) +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L18) ---- +___ ### events @@ -147,9 +147,9 @@ ProviderCondition.events #### Defined in -[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L20) +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L20) ---- +___ ### version @@ -161,17 +161,17 @@ ProviderCondition.version #### Defined in -[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L21) +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L21) ---- +___ -### NO_EXPIRY +### NO\_EXPIRY -▪ `Static` `Readonly` **NO_EXPIRY**: `0` +▪ `Static` `Readonly` **NO\_EXPIRY**: ``0`` #### Defined in -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:27](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L27) +[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:27](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L27) ## Accessors @@ -189,9 +189,9 @@ ProviderCondition.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -207,9 +207,9 @@ ProviderCondition.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -225,9 +225,9 @@ ProviderCondition.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -243,9 +243,9 @@ ProviderCondition.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -261,9 +261,9 @@ ProviderCondition.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -279,9 +279,9 @@ ProviderCondition.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -297,9 +297,9 @@ ProviderCondition.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -315,9 +315,9 @@ ProviderCondition.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -327,69 +327,69 @@ ProviderCondition.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -397,9 +397,9 @@ ProviderCondition.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -409,38 +409,38 @@ ProviderCondition.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -448,7 +448,7 @@ ProviderCondition.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -458,11 +458,11 @@ ProviderCondition.walletClient #### Parameters -| Name | Type | -| :------------ | :---------------------------------------------- | -| `conditionId` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `conditionId` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -474,9 +474,9 @@ ProviderCondition.abortByTimeOut #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L75) +[src/keeper/contracts/conditions/Condition.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L75) ---- +___ ### call @@ -485,16 +485,16 @@ ProviderCondition.abortByTimeOut #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `args` | `any`[] | -| `from?` | `string` | +| `args` | `any`[] | +| `from?` | `string` | #### Returns @@ -506,9 +506,9 @@ ProviderCondition.call #### Defined in -[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L91) +[src/keeper/contracts/ContractBase.ts:91](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L91) ---- +___ ### fulfill @@ -518,18 +518,18 @@ Fulfill the transfer NFT condition. #### Parameters -| Name | Type | Default value | Description | -| :--------------------- | :---------------------------------------------- | :------------ | :--------------------------------------------------- | -| `agreementId` | `string` | `undefined` | The agreement identifier. | -| `did` | `string` | `undefined` | The DID of the asset with NFTs. | -| `nftReceiver` | `string` | `undefined` | The address of the account to receive the NFT. | -| `nftAmount` | `bigint` | `undefined` | amount of NFTs to transfer. | -| `nftContractAddress` | `string` | `undefined` | Address of the nft contract | -| `lockPaymentCondition` | `string` | `undefined` | lock payment condition identifier. | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | | -| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | -| `expiration` | `number` | `0` | - | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | The agreement identifier. | +| `did` | `string` | `undefined` | The DID of the asset with NFTs. | +| `nftReceiver` | `string` | `undefined` | The address of the account to receive the NFT. | +| `nftAmount` | `bigint` | `undefined` | amount of NFTs to transfer. | +| `nftContractAddress` | `string` | `undefined` | Address of the nft contract | +| `lockPaymentCondition` | `string` | `undefined` | lock payment condition identifier. | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | | +| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | +| `expiration` | `number` | `0` | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | #### Returns @@ -547,9 +547,9 @@ ProviderCondition.fulfill #### Defined in -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:146](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L146) +[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:146](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L146) ---- +___ ### fulfillForDelegate @@ -559,19 +559,19 @@ Fulfill the transfer NFT condition. #### Parameters -| Name | Type | Default value | Description | -| :--------------------- | :---------------------------------------------- | :------------ | :------------------------------------------------------------ | -| `agreementId` | `string` | `undefined` | The agreement identifier. | -| `did` | `string` | `undefined` | The DID of the asset with NFTs. | -| `nftHolder` | `string` | `undefined` | The address of the account currently holding the NFT. | -| `nftReceiver` | `string` | `undefined` | The address of the account to receive the NFT. | -| `nftAmount` | `bigint` | `undefined` | The amount of NFTs to transfer. | -| `lockPaymentCondition` | `string` | `undefined` | The lock payment condition identifier. | -| `nftAddress` | `string` | `undefined` | - | -| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | -| `expiration` | `bigint` | `undefined` | Block in which the token expires. If zero means no expiration | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account sending the transaction | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Transaction parameters | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | The agreement identifier. | +| `did` | `string` | `undefined` | The DID of the asset with NFTs. | +| `nftHolder` | `string` | `undefined` | The address of the account currently holding the NFT. | +| `nftReceiver` | `string` | `undefined` | The address of the account to receive the NFT. | +| `nftAmount` | `bigint` | `undefined` | The amount of NFTs to transfer. | +| `lockPaymentCondition` | `string` | `undefined` | The lock payment condition identifier. | +| `nftAddress` | `string` | `undefined` | - | +| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | +| `expiration` | `bigint` | `undefined` | Block in which the token expires. If zero means no expiration | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | Account sending the transaction | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Transaction parameters | #### Returns @@ -585,9 +585,9 @@ Only DID owner or DID provider can call this method. #### Defined in -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:192](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L192) +[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:192](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L192) ---- +___ ### fulfillInstance @@ -595,13 +595,13 @@ Only DID owner or DID provider can call this method. #### Parameters -| Name | Type | Default value | -| :----------------- | :-------------------------------------------------------- | :------------ | -| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`\<`string`, `unknown`\> | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -613,9 +613,9 @@ ProviderCondition.fulfillInstance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L139) +[src/keeper/contracts/conditions/Condition.abstract.ts:139](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L139) ---- +___ ### fulfillPlain @@ -623,13 +623,13 @@ ProviderCondition.fulfillInstance #### Parameters -| Name | Type | Default value | -| :------------ | :-------------------------------------------------------- | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | -| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from` | [`NvmAccount`](NvmAccount.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns @@ -641,9 +641,9 @@ ProviderCondition.fulfillPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L47) +[src/keeper/contracts/conditions/Condition.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L47) ---- +___ ### fulfillWithNode @@ -651,12 +651,12 @@ ProviderCondition.fulfillPlain #### Parameters -| Name | Type | -| :----------------- | :----------------------------------------------------- | -| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | -| `additionalParams` | `Record`\<`string`, `unknown`\> | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `cond` | `ConditionInstance`\<`Record`\<`string`, `unknown`\>\> | +| `additionalParams` | `Record`\<`string`, `unknown`\> | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -668,9 +668,9 @@ ProviderCondition.fulfillWithNode #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L183) +[src/keeper/contracts/conditions/Condition.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L183) ---- +___ ### generateId @@ -678,10 +678,10 @@ ProviderCondition.fulfillWithNode #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -693,9 +693,9 @@ ProviderCondition.generateId #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L61) +[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L61) ---- +___ ### generateIdHash @@ -703,10 +703,10 @@ ProviderCondition.generateId #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `...values` | `any`[] | +| `...values` | `any`[] | #### Returns @@ -718,9 +718,9 @@ ProviderCondition.generateIdHash #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L57) +[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L57) ---- +___ ### generateIdWithSeed @@ -728,10 +728,10 @@ ProviderCondition.generateIdHash #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | -| `valueHash` | `string` | +| `valueHash` | `string` | #### Returns @@ -743,9 +743,9 @@ ProviderCondition.generateIdWithSeed #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L65) +[src/keeper/contracts/conditions/Condition.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L65) ---- +___ ### getConditionFulfilledEvent @@ -753,8 +753,8 @@ ProviderCondition.generateIdWithSeed #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns @@ -767,9 +767,9 @@ ProviderCondition.getConditionFulfilledEvent #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L79) +[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L79) ---- +___ ### getFromAddress @@ -777,8 +777,8 @@ ProviderCondition.getConditionFulfilledEvent #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `from?` | `string` | #### Returns @@ -791,24 +791,24 @@ ProviderCondition.getFromAddress #### Defined in -[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L67) +[src/keeper/contracts/ContractBase.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L67) ---- +___ ### getTransactionLogs -▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +▸ **getTransactionLogs**(`txReceipt`, `eventName`): `ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Parameters -| Name | Type | -| :---------- | :------------------- | +| Name | Type | +| :------ | :------ | | `txReceipt` | `TransactionReceipt` | -| `eventName` | `string` | +| `eventName` | `string` | #### Returns -`ParseEventLogsReturnType`\<`any`, `string`, `false`, `string`\> +`ParseEventLogsReturnType`\<`any`, `string`, ``false``, `string`\> #### Inherited from @@ -816,9 +816,9 @@ ProviderCondition.getTransactionLogs #### Defined in -[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L75) +[src/keeper/contracts/ContractBase.ts:75](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L75) ---- +___ ### hashValues @@ -826,8 +826,8 @@ ProviderCondition.getTransactionLogs #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -840,9 +840,9 @@ ProviderCondition.hashValues #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L116) +[src/keeper/contracts/conditions/Condition.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L116) ---- +___ ### hashValuesPlain @@ -850,8 +850,8 @@ ProviderCondition.hashValues #### Parameters -| Name | Type | -| :-------- | :------ | +| Name | Type | +| :------ | :------ | | `...args` | `any`[] | #### Returns @@ -864,9 +864,9 @@ ProviderCondition.hashValuesPlain #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L122) +[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L122) ---- +___ ### init @@ -874,11 +874,11 @@ ProviderCondition.hashValuesPlain #### Parameters -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------- | :------------ | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | -| `optional` | `boolean` | `false` | -| `contractAddress?` | `string` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | +| `contractAddress?` | `string` | `undefined` | #### Returns @@ -890,9 +890,9 @@ ProviderCondition.init #### Defined in -[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L29) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L29) ---- +___ ### instance @@ -900,10 +900,10 @@ ProviderCondition.init #### Parameters -| Name | Type | -| :------------ | :------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `params` | `ConditionParameters`\<`Record`\<`string`, `unknown`\>\> | #### Returns @@ -915,9 +915,9 @@ ProviderCondition.instance #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L163) +[src/keeper/contracts/conditions/Condition.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L163) ---- +___ ### instanceFromDDO @@ -925,11 +925,11 @@ ProviderCondition.instance #### Parameters -| Name | Type | -| :------------ | :-------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `TransferNFTConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | +| Name | Type | +| :------ | :------ | +| `agreementId` | `string` | +| `ctx` | `TransferNFTConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | #### Returns @@ -941,9 +941,9 @@ ProviderCondition.instanceFromDDO #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/Condition.abstract.ts#L131) +[src/keeper/contracts/conditions/Condition.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/Condition.abstract.ts#L131) ---- +___ ### nftContractFromService @@ -951,8 +951,8 @@ ProviderCondition.instanceFromDDO #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------ | +| Name | Type | +| :------ | :------ | | `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | #### Returns @@ -961,9 +961,9 @@ ProviderCondition.instanceFromDDO #### Defined in -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:97](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L97) +[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:97](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L97) ---- +___ ### nodeMethod @@ -979,9 +979,9 @@ ProviderCondition.nodeMethod #### Defined in -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:218](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L218) +[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:218](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L218) ---- +___ ### params @@ -991,16 +991,16 @@ Generates the hash of condition inputs. #### Parameters -| Name | Type | Default value | Description | -| :-------------------- | :-------- | :------------ | :--------------------------------------------------- | -| `did` | `string` | `undefined` | The DID of the asset with NFTs. | -| `nftHolder` | `string` | `undefined` | The address of the holder of the NFT. | -| `nftReceiver` | `string` | `undefined` | The address of the granted user or the DID provider. | -| `nftAmount` | `bigint` | `undefined` | Amount of NFTs to transfer. | -| `lockCondition` | `string` | `undefined` | Lock condition identifier. | -| `nftContractAddress?` | `string` | `undefined` | The address of the NFT token to use. | -| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | -| `expiration` | `number` | `0` | - | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `did` | `string` | `undefined` | The DID of the asset with NFTs. | +| `nftHolder` | `string` | `undefined` | The address of the holder of the NFT. | +| `nftReceiver` | `string` | `undefined` | The address of the granted user or the DID provider. | +| `nftAmount` | `bigint` | `undefined` | Amount of NFTs to transfer. | +| `lockCondition` | `string` | `undefined` | Lock condition identifier. | +| `nftContractAddress?` | `string` | `undefined` | The address of the NFT token to use. | +| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | +| `expiration` | `number` | `0` | - | #### Returns @@ -1014,9 +1014,9 @@ ProviderCondition.params #### Defined in -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:45](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L45) +[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:45](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L45) ---- +___ ### paramsFromDDO @@ -1024,10 +1024,10 @@ ProviderCondition.params #### Parameters -| Name | Type | -| :--------------- | :---------------------------- | +| Name | Type | +| :------ | :------ | | `«destructured»` | `TransferNFTConditionContext` | -| `lockCondition` | `any` | +| `lockCondition` | `any` | #### Returns @@ -1039,9 +1039,9 @@ ProviderCondition.paramsFromDDO #### Defined in -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:104](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L104) +[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:104](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L104) ---- +___ ### send @@ -1049,12 +1049,12 @@ ProviderCondition.paramsFromDDO #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `args` | `any`[] | -| `params` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1066,9 +1066,9 @@ ProviderCondition.send #### Defined in -[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L127) +[src/keeper/contracts/ContractBase.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L127) ---- +___ ### sendFrom @@ -1076,12 +1076,12 @@ ProviderCondition.send #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | -| `functionName` | `string` | -| `args` | `any`[] | -| `from` | [`NvmAccount`](NvmAccount.md) | -| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `functionName` | `string` | +| `args` | `any`[] | +| `from` | [`NvmAccount`](NvmAccount.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -1093,9 +1093,9 @@ ProviderCondition.sendFrom #### Defined in -[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L108) +[src/keeper/contracts/ContractBase.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L108) ---- +___ ### setInstanceConfig @@ -1103,8 +1103,8 @@ ProviderCondition.sendFrom #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1117,9 +1117,9 @@ ProviderCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### someLog @@ -1127,8 +1127,8 @@ ProviderCondition.setInstanceConfig #### Parameters -| Name | Type | -| :----- | :------ | +| Name | Type | +| :------ | :------ | | `logs` | `any`[] | #### Returns @@ -1141,9 +1141,9 @@ ProviderCondition.someLog #### Defined in -[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/ContractBase.ts#L84) +[src/keeper/contracts/ContractBase.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/ContractBase.ts#L84) ---- +___ ### getInstance @@ -1151,8 +1151,8 @@ ProviderCondition.someLog #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1165,9 +1165,9 @@ ProviderCondition.getInstance #### Defined in -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L29) +[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L29) ---- +___ ### setInstanceConfig @@ -1175,15 +1175,15 @@ ProviderCondition.getInstance #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1196,4 +1196,4 @@ ProviderCondition.setInstanceConfig #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/UtilsApi.md b/docs/nevermined-sdk/api-reference/classes/UtilsApi.md index 76d37ab35b..5e1459ddae 100644 --- a/docs/nevermined-sdk/api-reference/classes/UtilsApi.md +++ b/docs/nevermined-sdk/api-reference/classes/UtilsApi.md @@ -56,10 +56,10 @@ Creates a new AssetsApi #### Parameters -| Name | Type | Description | -| :------------ | :------------------------------------------------------------------------------------ | :--------------------------------------- | -| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Configuration of the Nevermined instance | -| `initOptions` | [`NeverminedInitializationOptions`](../interfaces/NeverminedInitializationOptions.md) | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Configuration of the Nevermined instance | +| `initOptions` | [`NeverminedInitializationOptions`](../interfaces/NeverminedInitializationOptions.md) | - | #### Returns @@ -73,7 +73,7 @@ Creates a new AssetsApi #### Defined in -[src/nevermined/api/UtilsApi.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/UtilsApi.ts#L61) +[src/nevermined/api/UtilsApi.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/UtilsApi.ts#L61) ## Properties @@ -85,9 +85,9 @@ Agreement utils. #### Defined in -[src/nevermined/api/UtilsApi.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/UtilsApi.ts#L19) +[src/nevermined/api/UtilsApi.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/UtilsApi.ts#L19) ---- +___ ### blockchain @@ -97,9 +97,9 @@ Blockchain utils. #### Defined in -[src/nevermined/api/UtilsApi.ts:34](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/UtilsApi.ts#L34) +[src/nevermined/api/UtilsApi.ts:34](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/UtilsApi.ts#L34) ---- +___ ### contractHandler @@ -109,9 +109,9 @@ Contract utils #### Defined in -[src/nevermined/api/UtilsApi.ts:54](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/UtilsApi.ts#L54) +[src/nevermined/api/UtilsApi.ts:54](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/UtilsApi.ts#L54) ---- +___ ### fetch @@ -121,9 +121,9 @@ Fetch utils. #### Defined in -[src/nevermined/api/UtilsApi.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/UtilsApi.ts#L24) +[src/nevermined/api/UtilsApi.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/UtilsApi.ts#L24) ---- +___ ### jwt @@ -133,9 +133,9 @@ Jwt utils. #### Defined in -[src/nevermined/api/UtilsApi.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/UtilsApi.ts#L29) +[src/nevermined/api/UtilsApi.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/UtilsApi.ts#L29) ---- +___ ### signature @@ -145,9 +145,9 @@ Signature utils. #### Defined in -[src/nevermined/api/UtilsApi.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/UtilsApi.ts#L39) +[src/nevermined/api/UtilsApi.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/UtilsApi.ts#L39) ---- +___ ### token @@ -157,9 +157,9 @@ Token utils. #### Defined in -[src/nevermined/api/UtilsApi.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/UtilsApi.ts#L44) +[src/nevermined/api/UtilsApi.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/UtilsApi.ts#L44) ---- +___ ### versions @@ -169,7 +169,7 @@ Token utils. #### Defined in -[src/nevermined/api/UtilsApi.ts:49](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/UtilsApi.ts#L49) +[src/nevermined/api/UtilsApi.ts:49](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/UtilsApi.ts#L49) ## Accessors @@ -187,9 +187,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -205,9 +205,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -223,9 +223,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -241,9 +241,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -259,9 +259,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -277,9 +277,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -295,9 +295,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -313,9 +313,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -325,69 +325,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -395,9 +395,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -407,38 +407,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -446,7 +446,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -456,8 +456,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -470,9 +470,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### getInstance @@ -480,8 +480,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -494,9 +494,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -504,15 +504,15 @@ Instantiable.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -525,4 +525,4 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/Versions.md b/docs/nevermined-sdk/api-reference/classes/Versions.md index fd58d3bf3b..9af9e323ae 100644 --- a/docs/nevermined-sdk/api-reference/classes/Versions.md +++ b/docs/nevermined-sdk/api-reference/classes/Versions.md @@ -46,8 +46,8 @@ Creates a new Versions #### Parameters -| Name | Type | Description | -| :------- | :---------------------------------------------------------- | :--------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Configuration of the Nevermined instance | #### Returns @@ -62,7 +62,7 @@ Creates a new Versions #### Defined in -[src/nevermined/Versions.ts:46](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L46) +[src/nevermined/Versions.ts:46](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L46) ## Accessors @@ -80,9 +80,9 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L132) +[src/Instantiable.abstract.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L132) ---- +___ ### circuitsFolder @@ -98,9 +98,9 @@ Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L136) +[src/Instantiable.abstract.ts:136](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L136) ---- +___ ### client @@ -116,9 +116,9 @@ Instantiable.client #### Defined in -[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L84) +[src/Instantiable.abstract.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L84) ---- +___ ### config @@ -134,9 +134,9 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L115) ---- +___ ### instanceConfig @@ -152,9 +152,9 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L140) +[src/Instantiable.abstract.ts:140](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L140) ---- +___ ### instantiableConfig @@ -170,9 +170,9 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L108) +[src/Instantiable.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L108) ---- +___ ### logger @@ -188,9 +188,9 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L123) +[src/Instantiable.abstract.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L123) ---- +___ ### nevermined @@ -206,9 +206,9 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L76) +[src/Instantiable.abstract.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L76) ---- +___ ### publicClient @@ -218,69 +218,69 @@ Instantiable.nevermined `Object` -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Inherited from @@ -288,9 +288,9 @@ Instantiable.publicClient #### Defined in -[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L92) +[src/Instantiable.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L92) ---- +___ ### walletClient @@ -300,38 +300,38 @@ Instantiable.publicClient `Object` -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Inherited from @@ -339,7 +339,7 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L100) ## Methods @@ -353,9 +353,9 @@ Instantiable.walletClient #### Defined in -[src/nevermined/Versions.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L51) +[src/nevermined/Versions.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L51) ---- +___ ### setInstanceConfig @@ -363,8 +363,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -377,9 +377,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L158) ---- +___ ### getInstance @@ -387,8 +387,8 @@ Instantiable.walletClient #### Parameters -| Name | Type | -| :--------- | :---- | +| Name | Type | +| :------ | :------ | | `..._args` | `any` | #### Returns @@ -401,9 +401,9 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L145) +[src/Instantiable.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L145) ---- +___ ### setInstanceConfig @@ -411,15 +411,15 @@ Instantiable.walletClient #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `T` | extends [`Instantiable`](Instantiable.md) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `instance` | `T` | +| Name | Type | +| :------ | :------ | +| `instance` | `T` | | `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -432,4 +432,4 @@ Instantiable.walletClient #### Defined in -[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L149) +[src/Instantiable.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L149) diff --git a/docs/nevermined-sdk/api-reference/classes/Web3Error.md b/docs/nevermined-sdk/api-reference/classes/Web3Error.md index 09ba96ffd3..83e7bc879a 100644 --- a/docs/nevermined-sdk/api-reference/classes/Web3Error.md +++ b/docs/nevermined-sdk/api-reference/classes/Web3Error.md @@ -35,8 +35,8 @@ #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `message` | `string` | #### Returns @@ -49,7 +49,7 @@ Error.constructor #### Defined in -[src/errors/NeverminedErrors.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/errors/NeverminedErrors.ts#L26) +[src/errors/NeverminedErrors.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/errors/NeverminedErrors.ts#L26) ## Properties @@ -65,7 +65,7 @@ Error.cause node_modules/typescript/lib/lib.es2022.error.d.ts:24 ---- +___ ### message @@ -79,7 +79,7 @@ Error.message node_modules/typescript/lib/lib.es5.d.ts:1077 ---- +___ ### name @@ -93,7 +93,7 @@ Error.name node_modules/typescript/lib/lib.es5.d.ts:1076 ---- +___ ### stack @@ -107,7 +107,7 @@ Error.stack node_modules/typescript/lib/lib.es5.d.ts:1078 ---- +___ ### prepareStackTrace @@ -125,9 +125,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ##### Parameters -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | +| Name | Type | +| :------ | :------ | +| `err` | `Error` | | `stackTraces` | `CallSite`[] | ##### Returns @@ -142,7 +142,7 @@ Error.prepareStackTrace node_modules/@types/node/globals.d.ts:28 ---- +___ ### stackTraceLimit @@ -166,9 +166,9 @@ Create .stack property on a target object #### Parameters -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | | `constructorOpt?` | `Function` | #### Returns diff --git a/docs/nevermined-sdk/api-reference/classes/WebServiceConnector.md b/docs/nevermined-sdk/api-reference/classes/WebServiceConnector.md index 2222a3e18a..65ab05e0f4 100644 --- a/docs/nevermined-sdk/api-reference/classes/WebServiceConnector.md +++ b/docs/nevermined-sdk/api-reference/classes/WebServiceConnector.md @@ -39,8 +39,8 @@ Provides a common interface to web services. #### Parameters -| Name | Type | -| :------- | :---------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -49,7 +49,7 @@ Provides a common interface to web services. #### Defined in -[src/nevermined/utils/WebServiceConnector.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/WebServiceConnector.ts#L26) +[src/nevermined/utils/WebServiceConnector.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/WebServiceConnector.ts#L26) ## Properties @@ -59,18 +59,18 @@ Provides a common interface to web services. #### Defined in -[src/nevermined/utils/WebServiceConnector.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/WebServiceConnector.ts#L24) +[src/nevermined/utils/WebServiceConnector.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/WebServiceConnector.ts#L24) ## Methods ### \_sleep -▸ **\_sleep**(`ms`): `Promise`\<`unknown`\> +▸ **_sleep**(`ms`): `Promise`\<`unknown`\> #### Parameters -| Name | Type | -| :--- | :------- | +| Name | Type | +| :------ | :------ | | `ms` | `number` | #### Returns @@ -79,9 +79,9 @@ Provides a common interface to web services. #### Defined in -[src/nevermined/utils/WebServiceConnector.ts:226](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/WebServiceConnector.ts#L226) +[src/nevermined/utils/WebServiceConnector.ts:226](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/WebServiceConnector.ts#L226) ---- +___ ### delete @@ -89,11 +89,11 @@ Provides a common interface to web services. #### Parameters -| Name | Type | -| :--------- | :--------- | -| `url` | `string` | +| Name | Type | +| :------ | :------ | +| `url` | `string` | | `payload?` | `BodyInit` | -| `headers` | `Object` | +| `headers` | `Object` | #### Returns @@ -101,9 +101,9 @@ Provides a common interface to web services. #### Defined in -[src/nevermined/utils/WebServiceConnector.ts:71](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/WebServiceConnector.ts#L71) +[src/nevermined/utils/WebServiceConnector.ts:71](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/WebServiceConnector.ts#L71) ---- +___ ### downloadFile @@ -111,12 +111,12 @@ Provides a common interface to web services. #### Parameters -| Name | Type | -| :------------- | :------- | -| `url` | `string` | +| Name | Type | +| :------ | :------ | +| `url` | `string` | | `destination?` | `string` | -| `index?` | `number` | -| `headers?` | `Object` | +| `index?` | `number` | +| `headers?` | `Object` | #### Returns @@ -124,9 +124,9 @@ Provides a common interface to web services. #### Defined in -[src/nevermined/utils/WebServiceConnector.ts:86](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/WebServiceConnector.ts#L86) +[src/nevermined/utils/WebServiceConnector.ts:86](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/WebServiceConnector.ts#L86) ---- +___ ### downloadUrl @@ -134,10 +134,10 @@ Provides a common interface to web services. #### Parameters -| Name | Type | -| :--------- | :------- | -| `url` | `string` | -| `headers?` | `any` | +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `headers?` | `any` | #### Returns @@ -145,9 +145,9 @@ Provides a common interface to web services. #### Defined in -[src/nevermined/utils/WebServiceConnector.ts:139](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/WebServiceConnector.ts#L139) +[src/nevermined/utils/WebServiceConnector.ts:139](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/WebServiceConnector.ts#L139) ---- +___ ### fetch @@ -155,11 +155,11 @@ Provides a common interface to web services. #### Parameters -| Name | Type | Default value | -| :------------ | :------------ | :------------ | -| `url` | `any` | `undefined` | -| `opts` | `RequestInit` | `undefined` | -| `numberTries` | `number` | `1` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `url` | `any` | `undefined` | +| `opts` | `RequestInit` | `undefined` | +| `numberTries` | `number` | `1` | #### Returns @@ -167,9 +167,9 @@ Provides a common interface to web services. #### Defined in -[src/nevermined/utils/WebServiceConnector.ts:209](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/WebServiceConnector.ts#L209) +[src/nevermined/utils/WebServiceConnector.ts:209](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/WebServiceConnector.ts#L209) ---- +___ ### fetchCID @@ -177,8 +177,8 @@ Provides a common interface to web services. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `cid` | `string` | #### Returns @@ -187,9 +187,9 @@ Provides a common interface to web services. #### Defined in -[src/nevermined/utils/WebServiceConnector.ts:181](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/WebServiceConnector.ts#L181) +[src/nevermined/utils/WebServiceConnector.ts:181](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/WebServiceConnector.ts#L181) ---- +___ ### fetchToken @@ -197,11 +197,11 @@ Provides a common interface to web services. #### Parameters -| Name | Type | Default value | -| :------------ | :------- | :------------ | -| `url` | `string` | `undefined` | -| `grantToken` | `string` | `undefined` | -| `numberTries` | `number` | `1` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `url` | `string` | `undefined` | +| `grantToken` | `string` | `undefined` | +| `numberTries` | `number` | `1` | #### Returns @@ -209,9 +209,9 @@ Provides a common interface to web services. #### Defined in -[src/nevermined/utils/WebServiceConnector.ts:165](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/WebServiceConnector.ts#L165) +[src/nevermined/utils/WebServiceConnector.ts:165](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/WebServiceConnector.ts#L165) ---- +___ ### get @@ -219,9 +219,9 @@ Provides a common interface to web services. #### Parameters -| Name | Type | -| :-------- | :------- | -| `url` | `any` | +| Name | Type | +| :------ | :------ | +| `url` | `any` | | `headers` | `Object` | #### Returns @@ -230,31 +230,31 @@ Provides a common interface to web services. #### Defined in -[src/nevermined/utils/WebServiceConnector.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/WebServiceConnector.ts#L47) +[src/nevermined/utils/WebServiceConnector.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/WebServiceConnector.ts#L47) ---- +___ ### getFileResponse -▸ **getFileResponse**(`url`, `index?`, `headers?`): `Promise`\<\{ `name`: `string` ; `response`: `Response` }\> +▸ **getFileResponse**(`url`, `index?`, `headers?`): `Promise`\<\{ `name`: `string` ; `response`: `Response` }\> #### Parameters -| Name | Type | -| :--------- | :------- | -| `url` | `string` | -| `index?` | `number` | +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `index?` | `number` | | `headers?` | `Object` | #### Returns -`Promise`\<\{ `name`: `string` ; `response`: `Response` }\> +`Promise`\<\{ `name`: `string` ; `response`: `Response` }\> #### Defined in -[src/nevermined/utils/WebServiceConnector.ts:113](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/WebServiceConnector.ts#L113) +[src/nevermined/utils/WebServiceConnector.ts:113](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/WebServiceConnector.ts#L113) ---- +___ ### post @@ -262,11 +262,11 @@ Provides a common interface to web services. #### Parameters -| Name | Type | -| :-------- | :--------- | -| `url` | `string` | +| Name | Type | +| :------ | :------ | +| `url` | `string` | | `payload` | `BodyInit` | -| `headers` | `Object` | +| `headers` | `Object` | #### Returns @@ -274,9 +274,9 @@ Provides a common interface to web services. #### Defined in -[src/nevermined/utils/WebServiceConnector.ts:32](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/WebServiceConnector.ts#L32) +[src/nevermined/utils/WebServiceConnector.ts:32](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/WebServiceConnector.ts#L32) ---- +___ ### put @@ -284,11 +284,11 @@ Provides a common interface to web services. #### Parameters -| Name | Type | -| :-------- | :--------- | -| `url` | `string` | +| Name | Type | +| :------ | :------ | +| `url` | `string` | | `payload` | `BodyInit` | -| `headers` | `Object` | +| `headers` | `Object` | #### Returns @@ -296,9 +296,9 @@ Provides a common interface to web services. #### Defined in -[src/nevermined/utils/WebServiceConnector.ts:56](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/WebServiceConnector.ts#L56) +[src/nevermined/utils/WebServiceConnector.ts:56](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/WebServiceConnector.ts#L56) ---- +___ ### uploadFile @@ -306,11 +306,11 @@ Provides a common interface to web services. #### Parameters -| Name | Type | -| :--------- | :----------- | -| `url` | `string` | -| `data` | `ReadStream` | -| `encrypt?` | `boolean` | +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `data` | `ReadStream` | +| `encrypt?` | `boolean` | #### Returns @@ -318,9 +318,9 @@ Provides a common interface to web services. #### Defined in -[src/nevermined/utils/WebServiceConnector.ts:156](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/WebServiceConnector.ts#L156) +[src/nevermined/utils/WebServiceConnector.ts:156](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/WebServiceConnector.ts#L156) ---- +___ ### uploadMessage @@ -328,10 +328,10 @@ Provides a common interface to web services. #### Parameters -| Name | Type | -| :--------- | :-------- | -| `url` | `string` | -| `data` | `string` | +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `data` | `string` | | `encrypt?` | `boolean` | #### Returns @@ -340,9 +340,9 @@ Provides a common interface to web services. #### Defined in -[src/nevermined/utils/WebServiceConnector.ts:147](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/WebServiceConnector.ts#L147) +[src/nevermined/utils/WebServiceConnector.ts:147](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/WebServiceConnector.ts#L147) ---- +___ ### getIPFSAuthToken @@ -354,4 +354,4 @@ Provides a common interface to web services. #### Defined in -[src/nevermined/utils/WebServiceConnector.ts:199](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/WebServiceConnector.ts#L199) +[src/nevermined/utils/WebServiceConnector.ts:199](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/WebServiceConnector.ts#L199) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.AaveBorrowCondition.md b/docs/nevermined-sdk/api-reference/classes/conditions.AaveBorrowCondition.md deleted file mode 100644 index 994753fd92..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.AaveBorrowCondition.md +++ /dev/null @@ -1,1119 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / AaveBorrowCondition - -# Class: AaveBorrowCondition - -[conditions](../modules/conditions.md).AaveBorrowCondition - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`AaveBorrowConditionContext`\> - - ↳ **`AaveBorrowCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.AaveBorrowCondition.md#constructor) - -### Properties - -- [contract](conditions.AaveBorrowCondition.md#contract) -- [contractName](conditions.AaveBorrowCondition.md#contractname) -- [events](conditions.AaveBorrowCondition.md#events) -- [version](conditions.AaveBorrowCondition.md#version) - -### Accessors - -- [address](conditions.AaveBorrowCondition.md#address) -- [artifactsFolder](conditions.AaveBorrowCondition.md#artifactsfolder) -- [config](conditions.AaveBorrowCondition.md#config) -- [instanceConfig](conditions.AaveBorrowCondition.md#instanceconfig) -- [instantiableConfig](conditions.AaveBorrowCondition.md#instantiableconfig) -- [logger](conditions.AaveBorrowCondition.md#logger) -- [nevermined](conditions.AaveBorrowCondition.md#nevermined) -- [web3](conditions.AaveBorrowCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.AaveBorrowCondition.md#abortbytimeout) -- [addresses](conditions.AaveBorrowCondition.md#addresses) -- [call](conditions.AaveBorrowCondition.md#call) -- [checkExists](conditions.AaveBorrowCondition.md#checkexists) -- [findSigner](conditions.AaveBorrowCondition.md#findsigner) -- [fulfill](conditions.AaveBorrowCondition.md#fulfill) -- [fulfillGateway](conditions.AaveBorrowCondition.md#fulfillgateway) -- [fulfillInstance](conditions.AaveBorrowCondition.md#fulfillinstance) -- [fulfillPlain](conditions.AaveBorrowCondition.md#fulfillplain) -- [gatewayMethod](conditions.AaveBorrowCondition.md#gatewaymethod) -- [generateId](conditions.AaveBorrowCondition.md#generateid) -- [generateIdHash](conditions.AaveBorrowCondition.md#generateidhash) -- [generateIdWithSeed](conditions.AaveBorrowCondition.md#generateidwithseed) -- [getAddress](conditions.AaveBorrowCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.AaveBorrowCondition.md#getconditionfulfilledevent) -- [getContract](conditions.AaveBorrowCondition.md#getcontract) -- [getFromAddress](conditions.AaveBorrowCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.AaveBorrowCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.AaveBorrowCondition.md#getsignatureofmethod) -- [hashValues](conditions.AaveBorrowCondition.md#hashvalues) -- [hashValuesPlain](conditions.AaveBorrowCondition.md#hashvaluesplain) -- [init](conditions.AaveBorrowCondition.md#init) -- [instance](conditions.AaveBorrowCondition.md#instance) -- [instanceFromDDO](conditions.AaveBorrowCondition.md#instancefromddo) -- [params](conditions.AaveBorrowCondition.md#params) -- [paramsFromDDO](conditions.AaveBorrowCondition.md#paramsfromddo) -- [send](conditions.AaveBorrowCondition.md#send) -- [sendFrom](conditions.AaveBorrowCondition.md#sendfrom) -- [setInstanceConfig](conditions.AaveBorrowCondition.md#setinstanceconfig) -- [addressesStatic](conditions.AaveBorrowCondition.md#addressesstatic) -- [findSignerStatic](conditions.AaveBorrowCondition.md#findsignerstatic) -- [getInstance](conditions.AaveBorrowCondition.md#getinstance) -- [setInstanceConfig](conditions.AaveBorrowCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new AaveBorrowCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `vaultAddress`, `assetToBorrow`, `amount`, `interestRateMode`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `vaultAddress` | `string` | -| `assetToBorrow` | `string` | -| `amount` | `string` | -| `interestRateMode` | `number` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/defi/AaveBorrowCondition.ts:62](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveBorrowCondition.ts#L62) - -___ - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | `AaveBorrowConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### params - -▸ **params**(`did`, `vaultAddress`, `assetToBorrow`, `amount`, `interestRateMode`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `vaultAddress` | `string` | -| `assetToBorrow` | `string` | -| `amount` | `string` | -| `interestRateMode` | `number` | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/defi/AaveBorrowCondition.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveBorrowCondition.ts#L30) - -___ - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `AaveBorrowConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/defi/AaveBorrowCondition.ts:46](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveBorrowCondition.ts#L46) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`AaveBorrowCondition`](conditions.AaveBorrowCondition.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`AaveBorrowCondition`](conditions.AaveBorrowCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/defi/AaveBorrowCondition.ts:19](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveBorrowCondition.ts#L19) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.AaveCollateralDepositCondition.md b/docs/nevermined-sdk/api-reference/classes/conditions.AaveCollateralDepositCondition.md deleted file mode 100644 index b55bc13302..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.AaveCollateralDepositCondition.md +++ /dev/null @@ -1,1123 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / AaveCollateralDepositCondition - -# Class: AaveCollateralDepositCondition - -[conditions](../modules/conditions.md).AaveCollateralDepositCondition - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`AaveCollateralDepositConditionContext`\> - - ↳ **`AaveCollateralDepositCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.AaveCollateralDepositCondition.md#constructor) - -### Properties - -- [contract](conditions.AaveCollateralDepositCondition.md#contract) -- [contractName](conditions.AaveCollateralDepositCondition.md#contractname) -- [events](conditions.AaveCollateralDepositCondition.md#events) -- [version](conditions.AaveCollateralDepositCondition.md#version) - -### Accessors - -- [address](conditions.AaveCollateralDepositCondition.md#address) -- [artifactsFolder](conditions.AaveCollateralDepositCondition.md#artifactsfolder) -- [config](conditions.AaveCollateralDepositCondition.md#config) -- [instanceConfig](conditions.AaveCollateralDepositCondition.md#instanceconfig) -- [instantiableConfig](conditions.AaveCollateralDepositCondition.md#instantiableconfig) -- [logger](conditions.AaveCollateralDepositCondition.md#logger) -- [nevermined](conditions.AaveCollateralDepositCondition.md#nevermined) -- [web3](conditions.AaveCollateralDepositCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.AaveCollateralDepositCondition.md#abortbytimeout) -- [addresses](conditions.AaveCollateralDepositCondition.md#addresses) -- [call](conditions.AaveCollateralDepositCondition.md#call) -- [checkExists](conditions.AaveCollateralDepositCondition.md#checkexists) -- [findSigner](conditions.AaveCollateralDepositCondition.md#findsigner) -- [fulfill](conditions.AaveCollateralDepositCondition.md#fulfill) -- [fulfillGateway](conditions.AaveCollateralDepositCondition.md#fulfillgateway) -- [fulfillInstance](conditions.AaveCollateralDepositCondition.md#fulfillinstance) -- [fulfillPlain](conditions.AaveCollateralDepositCondition.md#fulfillplain) -- [gatewayMethod](conditions.AaveCollateralDepositCondition.md#gatewaymethod) -- [generateId](conditions.AaveCollateralDepositCondition.md#generateid) -- [generateIdHash](conditions.AaveCollateralDepositCondition.md#generateidhash) -- [generateIdWithSeed](conditions.AaveCollateralDepositCondition.md#generateidwithseed) -- [getAddress](conditions.AaveCollateralDepositCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.AaveCollateralDepositCondition.md#getconditionfulfilledevent) -- [getContract](conditions.AaveCollateralDepositCondition.md#getcontract) -- [getFromAddress](conditions.AaveCollateralDepositCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.AaveCollateralDepositCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.AaveCollateralDepositCondition.md#getsignatureofmethod) -- [hashValues](conditions.AaveCollateralDepositCondition.md#hashvalues) -- [hashValuesPlain](conditions.AaveCollateralDepositCondition.md#hashvaluesplain) -- [init](conditions.AaveCollateralDepositCondition.md#init) -- [instance](conditions.AaveCollateralDepositCondition.md#instance) -- [instanceFromDDO](conditions.AaveCollateralDepositCondition.md#instancefromddo) -- [params](conditions.AaveCollateralDepositCondition.md#params) -- [paramsFromDDO](conditions.AaveCollateralDepositCondition.md#paramsfromddo) -- [send](conditions.AaveCollateralDepositCondition.md#send) -- [sendFrom](conditions.AaveCollateralDepositCondition.md#sendfrom) -- [setInstanceConfig](conditions.AaveCollateralDepositCondition.md#setinstanceconfig) -- [addressesStatic](conditions.AaveCollateralDepositCondition.md#addressesstatic) -- [findSignerStatic](conditions.AaveCollateralDepositCondition.md#findsignerstatic) -- [getInstance](conditions.AaveCollateralDepositCondition.md#getinstance) -- [setInstanceConfig](conditions.AaveCollateralDepositCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new AaveCollateralDepositCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `vaultAddress`, `collateralAsset`, `collateralAmount`, `delegatedAsset`, `delegatedAmount`, `interestRateMode`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `vaultAddress` | `string` | -| `collateralAsset` | `string` | -| `collateralAmount` | `string` | -| `delegatedAsset` | `string` | -| `delegatedAmount` | `string` | -| `interestRateMode` | `number` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/defi/AaveCollateralDepositCondition.ts:71](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCollateralDepositCondition.ts#L71) - -___ - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | `AaveCollateralDepositConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### params - -▸ **params**(`did`, `vaultAddress`, `collateralAsset`, `collateralAmount`, `delegatedAsset`, `delegatedAmount`, `interestRateMode`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `vaultAddress` | `string` | -| `collateralAsset` | `string` | -| `collateralAmount` | `string` | -| `delegatedAsset` | `string` | -| `delegatedAmount` | `string` | -| `interestRateMode` | `number` | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/defi/AaveCollateralDepositCondition.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCollateralDepositCondition.ts#L32) - -___ - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `AaveCollateralDepositConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/defi/AaveCollateralDepositCondition.ts:51](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCollateralDepositCondition.ts#L51) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`AaveCollateralDepositCondition`](conditions.AaveCollateralDepositCondition.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`AaveCollateralDepositCondition`](conditions.AaveCollateralDepositCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/defi/AaveCollateralDepositCondition.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCollateralDepositCondition.ts#L21) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.AaveCollateralWithdrawCondition.md b/docs/nevermined-sdk/api-reference/classes/conditions.AaveCollateralWithdrawCondition.md deleted file mode 100644 index 1da97a9f7d..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.AaveCollateralWithdrawCondition.md +++ /dev/null @@ -1,1115 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / AaveCollateralWithdrawCondition - -# Class: AaveCollateralWithdrawCondition - -[conditions](../modules/conditions.md).AaveCollateralWithdrawCondition - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`AaveCollateralWithdrawConditionContext`\> - - ↳ **`AaveCollateralWithdrawCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.AaveCollateralWithdrawCondition.md#constructor) - -### Properties - -- [contract](conditions.AaveCollateralWithdrawCondition.md#contract) -- [contractName](conditions.AaveCollateralWithdrawCondition.md#contractname) -- [events](conditions.AaveCollateralWithdrawCondition.md#events) -- [version](conditions.AaveCollateralWithdrawCondition.md#version) - -### Accessors - -- [address](conditions.AaveCollateralWithdrawCondition.md#address) -- [artifactsFolder](conditions.AaveCollateralWithdrawCondition.md#artifactsfolder) -- [config](conditions.AaveCollateralWithdrawCondition.md#config) -- [instanceConfig](conditions.AaveCollateralWithdrawCondition.md#instanceconfig) -- [instantiableConfig](conditions.AaveCollateralWithdrawCondition.md#instantiableconfig) -- [logger](conditions.AaveCollateralWithdrawCondition.md#logger) -- [nevermined](conditions.AaveCollateralWithdrawCondition.md#nevermined) -- [web3](conditions.AaveCollateralWithdrawCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.AaveCollateralWithdrawCondition.md#abortbytimeout) -- [addresses](conditions.AaveCollateralWithdrawCondition.md#addresses) -- [call](conditions.AaveCollateralWithdrawCondition.md#call) -- [checkExists](conditions.AaveCollateralWithdrawCondition.md#checkexists) -- [findSigner](conditions.AaveCollateralWithdrawCondition.md#findsigner) -- [fulfill](conditions.AaveCollateralWithdrawCondition.md#fulfill) -- [fulfillGateway](conditions.AaveCollateralWithdrawCondition.md#fulfillgateway) -- [fulfillInstance](conditions.AaveCollateralWithdrawCondition.md#fulfillinstance) -- [fulfillPlain](conditions.AaveCollateralWithdrawCondition.md#fulfillplain) -- [gatewayMethod](conditions.AaveCollateralWithdrawCondition.md#gatewaymethod) -- [generateId](conditions.AaveCollateralWithdrawCondition.md#generateid) -- [generateIdHash](conditions.AaveCollateralWithdrawCondition.md#generateidhash) -- [generateIdWithSeed](conditions.AaveCollateralWithdrawCondition.md#generateidwithseed) -- [getAddress](conditions.AaveCollateralWithdrawCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.AaveCollateralWithdrawCondition.md#getconditionfulfilledevent) -- [getContract](conditions.AaveCollateralWithdrawCondition.md#getcontract) -- [getFromAddress](conditions.AaveCollateralWithdrawCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.AaveCollateralWithdrawCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.AaveCollateralWithdrawCondition.md#getsignatureofmethod) -- [hashValues](conditions.AaveCollateralWithdrawCondition.md#hashvalues) -- [hashValuesPlain](conditions.AaveCollateralWithdrawCondition.md#hashvaluesplain) -- [init](conditions.AaveCollateralWithdrawCondition.md#init) -- [instance](conditions.AaveCollateralWithdrawCondition.md#instance) -- [instanceFromDDO](conditions.AaveCollateralWithdrawCondition.md#instancefromddo) -- [params](conditions.AaveCollateralWithdrawCondition.md#params) -- [paramsFromDDO](conditions.AaveCollateralWithdrawCondition.md#paramsfromddo) -- [send](conditions.AaveCollateralWithdrawCondition.md#send) -- [sendFrom](conditions.AaveCollateralWithdrawCondition.md#sendfrom) -- [setInstanceConfig](conditions.AaveCollateralWithdrawCondition.md#setinstanceconfig) -- [addressesStatic](conditions.AaveCollateralWithdrawCondition.md#addressesstatic) -- [findSignerStatic](conditions.AaveCollateralWithdrawCondition.md#findsignerstatic) -- [getInstance](conditions.AaveCollateralWithdrawCondition.md#getinstance) -- [setInstanceConfig](conditions.AaveCollateralWithdrawCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new AaveCollateralWithdrawCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `vaultAddress`, `collateralAsset`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `vaultAddress` | `string` | -| `collateralAsset` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts:40](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts#L40) - -___ - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | `AaveCollateralWithdrawConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### params - -▸ **params**(`did`, `vaultAddress`, `collateralAsset`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `vaultAddress` | `string` | -| `collateralAsset` | `string` | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts#L28) - -___ - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `AaveCollateralWithdrawConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts#L32) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`AaveCollateralWithdrawCondition`](conditions.AaveCollateralWithdrawCondition.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`AaveCollateralWithdrawCondition`](conditions.AaveCollateralWithdrawCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts:17](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts#L17) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.AaveRepayCondition.md b/docs/nevermined-sdk/api-reference/classes/conditions.AaveRepayCondition.md deleted file mode 100644 index bba88051c7..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.AaveRepayCondition.md +++ /dev/null @@ -1,1119 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / AaveRepayCondition - -# Class: AaveRepayCondition - -[conditions](../modules/conditions.md).AaveRepayCondition - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`AaveRepayConditionContext`\> - - ↳ **`AaveRepayCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.AaveRepayCondition.md#constructor) - -### Properties - -- [contract](conditions.AaveRepayCondition.md#contract) -- [contractName](conditions.AaveRepayCondition.md#contractname) -- [events](conditions.AaveRepayCondition.md#events) -- [version](conditions.AaveRepayCondition.md#version) - -### Accessors - -- [address](conditions.AaveRepayCondition.md#address) -- [artifactsFolder](conditions.AaveRepayCondition.md#artifactsfolder) -- [config](conditions.AaveRepayCondition.md#config) -- [instanceConfig](conditions.AaveRepayCondition.md#instanceconfig) -- [instantiableConfig](conditions.AaveRepayCondition.md#instantiableconfig) -- [logger](conditions.AaveRepayCondition.md#logger) -- [nevermined](conditions.AaveRepayCondition.md#nevermined) -- [web3](conditions.AaveRepayCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.AaveRepayCondition.md#abortbytimeout) -- [addresses](conditions.AaveRepayCondition.md#addresses) -- [call](conditions.AaveRepayCondition.md#call) -- [checkExists](conditions.AaveRepayCondition.md#checkexists) -- [findSigner](conditions.AaveRepayCondition.md#findsigner) -- [fulfill](conditions.AaveRepayCondition.md#fulfill) -- [fulfillGateway](conditions.AaveRepayCondition.md#fulfillgateway) -- [fulfillInstance](conditions.AaveRepayCondition.md#fulfillinstance) -- [fulfillPlain](conditions.AaveRepayCondition.md#fulfillplain) -- [gatewayMethod](conditions.AaveRepayCondition.md#gatewaymethod) -- [generateId](conditions.AaveRepayCondition.md#generateid) -- [generateIdHash](conditions.AaveRepayCondition.md#generateidhash) -- [generateIdWithSeed](conditions.AaveRepayCondition.md#generateidwithseed) -- [getAddress](conditions.AaveRepayCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.AaveRepayCondition.md#getconditionfulfilledevent) -- [getContract](conditions.AaveRepayCondition.md#getcontract) -- [getFromAddress](conditions.AaveRepayCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.AaveRepayCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.AaveRepayCondition.md#getsignatureofmethod) -- [hashValues](conditions.AaveRepayCondition.md#hashvalues) -- [hashValuesPlain](conditions.AaveRepayCondition.md#hashvaluesplain) -- [init](conditions.AaveRepayCondition.md#init) -- [instance](conditions.AaveRepayCondition.md#instance) -- [instanceFromDDO](conditions.AaveRepayCondition.md#instancefromddo) -- [params](conditions.AaveRepayCondition.md#params) -- [paramsFromDDO](conditions.AaveRepayCondition.md#paramsfromddo) -- [send](conditions.AaveRepayCondition.md#send) -- [sendFrom](conditions.AaveRepayCondition.md#sendfrom) -- [setInstanceConfig](conditions.AaveRepayCondition.md#setinstanceconfig) -- [addressesStatic](conditions.AaveRepayCondition.md#addressesstatic) -- [findSignerStatic](conditions.AaveRepayCondition.md#findsignerstatic) -- [getInstance](conditions.AaveRepayCondition.md#getinstance) -- [setInstanceConfig](conditions.AaveRepayCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new AaveRepayCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `vaultAddress`, `assetToRepay`, `amountToRepay`, `interestRateMode`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `vaultAddress` | `string` | -| `assetToRepay` | `string` | -| `amountToRepay` | `string` | -| `interestRateMode` | `number` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/defi/AaveRepayCondition.ts:61](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveRepayCondition.ts#L61) - -___ - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | `AaveRepayConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### params - -▸ **params**(`did`, `vaultAddress`, `assetToRepay`, `amountToRepay`, `interestRateMode`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `vaultAddress` | `string` | -| `assetToRepay` | `string` | -| `amountToRepay` | `string` | -| `interestRateMode` | `number` | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/defi/AaveRepayCondition.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveRepayCondition.ts#L30) - -___ - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `AaveRepayConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/defi/AaveRepayCondition.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveRepayCondition.ts#L45) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`AaveRepayCondition`](conditions.AaveRepayCondition.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`AaveRepayCondition`](conditions.AaveRepayCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/defi/AaveRepayCondition.ts:19](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveRepayCondition.ts#L19) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.AccessCondition.md b/docs/nevermined-sdk/api-reference/classes/conditions.AccessCondition.md deleted file mode 100644 index 67b6065f0d..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.AccessCondition.md +++ /dev/null @@ -1,1157 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / AccessCondition - -# Class: AccessCondition - -[conditions](../modules/conditions.md).AccessCondition - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`AccessConditionContext`\> - - ↳ **`AccessCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.AccessCondition.md#constructor) - -### Properties - -- [contract](conditions.AccessCondition.md#contract) -- [contractName](conditions.AccessCondition.md#contractname) -- [events](conditions.AccessCondition.md#events) -- [version](conditions.AccessCondition.md#version) - -### Accessors - -- [address](conditions.AccessCondition.md#address) -- [artifactsFolder](conditions.AccessCondition.md#artifactsfolder) -- [config](conditions.AccessCondition.md#config) -- [instanceConfig](conditions.AccessCondition.md#instanceconfig) -- [instantiableConfig](conditions.AccessCondition.md#instantiableconfig) -- [logger](conditions.AccessCondition.md#logger) -- [nevermined](conditions.AccessCondition.md#nevermined) -- [web3](conditions.AccessCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.AccessCondition.md#abortbytimeout) -- [addresses](conditions.AccessCondition.md#addresses) -- [call](conditions.AccessCondition.md#call) -- [checkExists](conditions.AccessCondition.md#checkexists) -- [checkPermissions](conditions.AccessCondition.md#checkpermissions) -- [findSigner](conditions.AccessCondition.md#findsigner) -- [fulfill](conditions.AccessCondition.md#fulfill) -- [fulfillGateway](conditions.AccessCondition.md#fulfillgateway) -- [fulfillInstance](conditions.AccessCondition.md#fulfillinstance) -- [fulfillPlain](conditions.AccessCondition.md#fulfillplain) -- [gatewayMethod](conditions.AccessCondition.md#gatewaymethod) -- [generateId](conditions.AccessCondition.md#generateid) -- [generateIdHash](conditions.AccessCondition.md#generateidhash) -- [generateIdWithSeed](conditions.AccessCondition.md#generateidwithseed) -- [getAddress](conditions.AccessCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.AccessCondition.md#getconditionfulfilledevent) -- [getContract](conditions.AccessCondition.md#getcontract) -- [getFromAddress](conditions.AccessCondition.md#getfromaddress) -- [getGrantedDidByConsumer](conditions.AccessCondition.md#getgranteddidbyconsumer) -- [getInputsOfMethod](conditions.AccessCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.AccessCondition.md#getsignatureofmethod) -- [hashValues](conditions.AccessCondition.md#hashvalues) -- [hashValuesPlain](conditions.AccessCondition.md#hashvaluesplain) -- [init](conditions.AccessCondition.md#init) -- [instance](conditions.AccessCondition.md#instance) -- [instanceFromDDO](conditions.AccessCondition.md#instancefromddo) -- [params](conditions.AccessCondition.md#params) -- [paramsFromDDO](conditions.AccessCondition.md#paramsfromddo) -- [send](conditions.AccessCondition.md#send) -- [sendFrom](conditions.AccessCondition.md#sendfrom) -- [setInstanceConfig](conditions.AccessCondition.md#setinstanceconfig) -- [addressesStatic](conditions.AccessCondition.md#addressesstatic) -- [findSignerStatic](conditions.AccessCondition.md#findsignerstatic) -- [getInstance](conditions.AccessCondition.md#getinstance) -- [setInstanceConfig](conditions.AccessCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new AccessCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### checkPermissions - -▸ **checkPermissions**(`grantee`, `did`, `from?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `grantee` | `string` | -| `did` | `string` | -| `from?` | [`Account`](Account.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[src/keeper/contracts/conditions/AccessCondition.ts:42](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/AccessCondition.ts#L42) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `grantee`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `grantee` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/AccessCondition.ts:27](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/AccessCondition.ts#L27) - -___ - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getGrantedDidByConsumer - -▸ **getGrantedDidByConsumer**(`consumer`): `Promise`<{ `agreementId`: `string` ; `did`: `string` }[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `consumer` | `string` | - -#### Returns - -`Promise`<{ `agreementId`: `string` ; `did`: `string` }[]\> - -#### Defined in - -[src/keeper/contracts/conditions/AccessCondition.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/AccessCondition.ts#L50) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | `AccessConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### params - -▸ **params**(`did`, `grantee`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `grantee` | `string` | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/AccessCondition.ts:19](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/AccessCondition.ts#L19) - -___ - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `AccessConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/AccessCondition.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/AccessCondition.ts#L23) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`AccessCondition`](conditions.AccessCondition.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`AccessCondition`](conditions.AccessCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/AccessCondition.ts:13](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/AccessCondition.ts#L13) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.ComputeExecutionCondition.md b/docs/nevermined-sdk/api-reference/classes/conditions.ComputeExecutionCondition.md deleted file mode 100644 index a38af7cd89..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.ComputeExecutionCondition.md +++ /dev/null @@ -1,1136 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / ComputeExecutionCondition - -# Class: ComputeExecutionCondition - -[conditions](../modules/conditions.md).ComputeExecutionCondition - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`ComputeExecutionConditionContext`\> - - ↳ **`ComputeExecutionCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.ComputeExecutionCondition.md#constructor) - -### Properties - -- [contract](conditions.ComputeExecutionCondition.md#contract) -- [contractName](conditions.ComputeExecutionCondition.md#contractname) -- [events](conditions.ComputeExecutionCondition.md#events) -- [version](conditions.ComputeExecutionCondition.md#version) - -### Accessors - -- [address](conditions.ComputeExecutionCondition.md#address) -- [artifactsFolder](conditions.ComputeExecutionCondition.md#artifactsfolder) -- [config](conditions.ComputeExecutionCondition.md#config) -- [instanceConfig](conditions.ComputeExecutionCondition.md#instanceconfig) -- [instantiableConfig](conditions.ComputeExecutionCondition.md#instantiableconfig) -- [logger](conditions.ComputeExecutionCondition.md#logger) -- [nevermined](conditions.ComputeExecutionCondition.md#nevermined) -- [web3](conditions.ComputeExecutionCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.ComputeExecutionCondition.md#abortbytimeout) -- [addresses](conditions.ComputeExecutionCondition.md#addresses) -- [call](conditions.ComputeExecutionCondition.md#call) -- [checkExists](conditions.ComputeExecutionCondition.md#checkexists) -- [findSigner](conditions.ComputeExecutionCondition.md#findsigner) -- [fulfill](conditions.ComputeExecutionCondition.md#fulfill) -- [fulfillGateway](conditions.ComputeExecutionCondition.md#fulfillgateway) -- [fulfillInstance](conditions.ComputeExecutionCondition.md#fulfillinstance) -- [fulfillPlain](conditions.ComputeExecutionCondition.md#fulfillplain) -- [gatewayMethod](conditions.ComputeExecutionCondition.md#gatewaymethod) -- [generateId](conditions.ComputeExecutionCondition.md#generateid) -- [generateIdHash](conditions.ComputeExecutionCondition.md#generateidhash) -- [generateIdWithSeed](conditions.ComputeExecutionCondition.md#generateidwithseed) -- [getAddress](conditions.ComputeExecutionCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.ComputeExecutionCondition.md#getconditionfulfilledevent) -- [getContract](conditions.ComputeExecutionCondition.md#getcontract) -- [getFromAddress](conditions.ComputeExecutionCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.ComputeExecutionCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.ComputeExecutionCondition.md#getsignatureofmethod) -- [hashValues](conditions.ComputeExecutionCondition.md#hashvalues) -- [hashValuesPlain](conditions.ComputeExecutionCondition.md#hashvaluesplain) -- [init](conditions.ComputeExecutionCondition.md#init) -- [instance](conditions.ComputeExecutionCondition.md#instance) -- [instanceFromDDO](conditions.ComputeExecutionCondition.md#instancefromddo) -- [params](conditions.ComputeExecutionCondition.md#params) -- [paramsFromDDO](conditions.ComputeExecutionCondition.md#paramsfromddo) -- [send](conditions.ComputeExecutionCondition.md#send) -- [sendFrom](conditions.ComputeExecutionCondition.md#sendfrom) -- [setInstanceConfig](conditions.ComputeExecutionCondition.md#setinstanceconfig) -- [wasComputeTriggered](conditions.ComputeExecutionCondition.md#wascomputetriggered) -- [addressesStatic](conditions.ComputeExecutionCondition.md#addressesstatic) -- [findSignerStatic](conditions.ComputeExecutionCondition.md#findsignerstatic) -- [getInstance](conditions.ComputeExecutionCondition.md#getinstance) -- [setInstanceConfig](conditions.ComputeExecutionCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new ComputeExecutionCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `computeConsumer`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `computeConsumer` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L30) - -___ - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | `ComputeExecutionConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### params - -▸ **params**(`did`, `computeConsumer`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `computeConsumer` | `string` | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L26) - -___ - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `ComputeExecutionConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L12) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### wasComputeTriggered - -▸ **wasComputeTriggered**(`did`, `computeConsumer`, `from?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `computeConsumer` | `string` | -| `from?` | [`Account`](Account.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L45) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`ComputeExecutionCondition`](conditions.ComputeExecutionCondition.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`ComputeExecutionCondition`](conditions.ComputeExecutionCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:16](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L16) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.ConditionSmall.md b/docs/nevermined-sdk/api-reference/classes/conditions.ConditionSmall.md deleted file mode 100644 index a082b01d53..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.ConditionSmall.md +++ /dev/null @@ -1,885 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / ConditionSmall - -# Class: ConditionSmall - -[conditions](../modules/conditions.md).ConditionSmall - -## Hierarchy - -- `ContractBase` - - ↳ **`ConditionSmall`** - - ↳↳ [`Condition`](Condition.md) - -## Table of contents - -### Constructors - -- [constructor](conditions.ConditionSmall.md#constructor) - -### Properties - -- [contract](conditions.ConditionSmall.md#contract) -- [contractName](conditions.ConditionSmall.md#contractname) -- [events](conditions.ConditionSmall.md#events) -- [version](conditions.ConditionSmall.md#version) - -### Accessors - -- [address](conditions.ConditionSmall.md#address) -- [artifactsFolder](conditions.ConditionSmall.md#artifactsfolder) -- [config](conditions.ConditionSmall.md#config) -- [instanceConfig](conditions.ConditionSmall.md#instanceconfig) -- [instantiableConfig](conditions.ConditionSmall.md#instantiableconfig) -- [logger](conditions.ConditionSmall.md#logger) -- [nevermined](conditions.ConditionSmall.md#nevermined) -- [web3](conditions.ConditionSmall.md#web3) - -### Methods - -- [abortByTimeOut](conditions.ConditionSmall.md#abortbytimeout) -- [addresses](conditions.ConditionSmall.md#addresses) -- [call](conditions.ConditionSmall.md#call) -- [checkExists](conditions.ConditionSmall.md#checkexists) -- [findSigner](conditions.ConditionSmall.md#findsigner) -- [fulfill](conditions.ConditionSmall.md#fulfill) -- [fulfillPlain](conditions.ConditionSmall.md#fulfillplain) -- [generateId](conditions.ConditionSmall.md#generateid) -- [generateIdHash](conditions.ConditionSmall.md#generateidhash) -- [generateIdWithSeed](conditions.ConditionSmall.md#generateidwithseed) -- [getAddress](conditions.ConditionSmall.md#getaddress) -- [getConditionFulfilledEvent](conditions.ConditionSmall.md#getconditionfulfilledevent) -- [getContract](conditions.ConditionSmall.md#getcontract) -- [getFromAddress](conditions.ConditionSmall.md#getfromaddress) -- [getInputsOfMethod](conditions.ConditionSmall.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.ConditionSmall.md#getsignatureofmethod) -- [hashValues](conditions.ConditionSmall.md#hashvalues) -- [init](conditions.ConditionSmall.md#init) -- [send](conditions.ConditionSmall.md#send) -- [sendFrom](conditions.ConditionSmall.md#sendfrom) -- [setInstanceConfig](conditions.ConditionSmall.md#setinstanceconfig) -- [addressesStatic](conditions.ConditionSmall.md#addressesstatic) -- [findSignerStatic](conditions.ConditionSmall.md#findsignerstatic) -- [getInstance](conditions.ConditionSmall.md#getinstance) -- [setInstanceConfig](conditions.ConditionSmall.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new ConditionSmall**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -ContractBase.constructor - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -ContractBase.contract - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -ContractBase.contractName - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -ContractBase.events - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -ContractBase.version - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ContractBase.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ContractBase.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ContractBase.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ContractBase.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ContractBase.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ContractBase.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ContractBase.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ContractBase.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -ContractBase.addresses - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -ContractBase.call - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -ContractBase.checkExists - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -ContractBase.findSigner - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ `Abstract` **fulfill**(`agreementId`, ...`args`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...args` | `any`[] | - -#### Returns - -`any` - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:67](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L67) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ContractBase.getAddress - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -ContractBase.getContract - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -ContractBase.getFromAddress - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -ContractBase.getInputsOfMethod - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -ContractBase.getSignatureOfMethod - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L63) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -ContractBase.init - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -ContractBase.send - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -ContractBase.sendFrom - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -ContractBase.setInstanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -ContractBase.addressesStatic - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -ContractBase.findSignerStatic - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**<`Ctx`, `Extra`\>(`config`, `conditionName`, `conditionsClass`, `optional?`): `Promise`<`any`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Extra` | - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `conditionName` | `string` | `undefined` | -| `conditionsClass` | `any` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`any`\> - -#### Overrides - -ContractBase.getInstance - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:52](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L52) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -ContractBase.setInstanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.ConsumerCondition.md b/docs/nevermined-sdk/api-reference/classes/conditions.ConsumerCondition.md deleted file mode 100644 index b1f9a1d2c7..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.ConsumerCondition.md +++ /dev/null @@ -1,1123 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / ConsumerCondition - -# Class: ConsumerCondition - -[conditions](../modules/conditions.md).ConsumerCondition - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Record`<`string`, `unknown`\> | - -## Hierarchy - -- [`Condition`](Condition.md)<`Ctx`, `Extra`\> - - ↳ **`ConsumerCondition`** - - ↳↳ [`LockPaymentCondition`](conditions.LockPaymentCondition.md) - - ↳↳ [`NFTHolderCondition`](conditions.NFTHolderCondition.md) - - ↳↳ [`NFT721HolderCondition`](conditions.NFT721HolderCondition.md) - - ↳↳ [`NFTLockCondition`](conditions.NFTLockCondition.md) - -## Table of contents - -### Constructors - -- [constructor](conditions.ConsumerCondition.md#constructor) - -### Properties - -- [contract](conditions.ConsumerCondition.md#contract) -- [contractName](conditions.ConsumerCondition.md#contractname) -- [events](conditions.ConsumerCondition.md#events) -- [version](conditions.ConsumerCondition.md#version) - -### Accessors - -- [address](conditions.ConsumerCondition.md#address) -- [artifactsFolder](conditions.ConsumerCondition.md#artifactsfolder) -- [config](conditions.ConsumerCondition.md#config) -- [instanceConfig](conditions.ConsumerCondition.md#instanceconfig) -- [instantiableConfig](conditions.ConsumerCondition.md#instantiableconfig) -- [logger](conditions.ConsumerCondition.md#logger) -- [nevermined](conditions.ConsumerCondition.md#nevermined) -- [web3](conditions.ConsumerCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.ConsumerCondition.md#abortbytimeout) -- [addresses](conditions.ConsumerCondition.md#addresses) -- [call](conditions.ConsumerCondition.md#call) -- [checkExists](conditions.ConsumerCondition.md#checkexists) -- [findSigner](conditions.ConsumerCondition.md#findsigner) -- [fulfill](conditions.ConsumerCondition.md#fulfill) -- [fulfillGateway](conditions.ConsumerCondition.md#fulfillgateway) -- [fulfillInstance](conditions.ConsumerCondition.md#fulfillinstance) -- [fulfillPlain](conditions.ConsumerCondition.md#fulfillplain) -- [generateId](conditions.ConsumerCondition.md#generateid) -- [generateIdHash](conditions.ConsumerCondition.md#generateidhash) -- [generateIdWithSeed](conditions.ConsumerCondition.md#generateidwithseed) -- [getAddress](conditions.ConsumerCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.ConsumerCondition.md#getconditionfulfilledevent) -- [getContract](conditions.ConsumerCondition.md#getcontract) -- [getFromAddress](conditions.ConsumerCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.ConsumerCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.ConsumerCondition.md#getsignatureofmethod) -- [hashValues](conditions.ConsumerCondition.md#hashvalues) -- [hashValuesPlain](conditions.ConsumerCondition.md#hashvaluesplain) -- [init](conditions.ConsumerCondition.md#init) -- [instance](conditions.ConsumerCondition.md#instance) -- [instanceFromDDO](conditions.ConsumerCondition.md#instancefromddo) -- [params](conditions.ConsumerCondition.md#params) -- [paramsFromDDO](conditions.ConsumerCondition.md#paramsfromddo) -- [send](conditions.ConsumerCondition.md#send) -- [sendFrom](conditions.ConsumerCondition.md#sendfrom) -- [setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig) -- [addressesStatic](conditions.ConsumerCondition.md#addressesstatic) -- [findSignerStatic](conditions.ConsumerCondition.md#findsignerstatic) -- [getInstance](conditions.ConsumerCondition.md#getinstance) -- [setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new ConsumerCondition**<`Ctx`, `Extra`\>(`contractName`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Record`<`string`, `unknown`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[Condition](Condition.md).[constructor](Condition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[Condition](Condition.md).[contract](Condition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[Condition](Condition.md).[contractName](Condition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[Condition](Condition.md).[events](Condition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[Condition](Condition.md).[version](Condition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -Condition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -Condition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -Condition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Condition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Condition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -Condition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -Condition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -Condition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[abortByTimeOut](Condition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[Condition](Condition.md).[addresses](Condition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[Condition](Condition.md).[call](Condition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[Condition](Condition.md).[checkExists](Condition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[Condition](Condition.md).[findSigner](Condition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ `Abstract` **fulfill**(`agreementId`, ...`args`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...args` | `any`[] | - -#### Returns - -`any` - -#### Inherited from - -[Condition](Condition.md).[fulfill](Condition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:67](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L67) - -___ - -### fulfillGateway - -▸ **fulfillGateway**(`_cond`, `_additionalParams`, `_from?`, `_params?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\> | -| `_additionalParams` | `Extra` | -| `_from?` | [`Account`](Account.md) | -| `_params?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Overrides - -[Condition](Condition.md).[fulfillGateway](Condition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:230](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L230) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\> | `undefined` | -| `additionalParams` | `Extra` | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[fulfillInstance](Condition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[fulfillPlain](Condition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[generateId](Condition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[generateIdHash](Condition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[Condition](Condition.md).[generateIdWithSeed](Condition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[Condition](Condition.md).[getAddress](Condition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[Condition](Condition.md).[getConditionFulfilledEvent](Condition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[Condition](Condition.md).[getContract](Condition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[getFromAddress](Condition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[Condition](Condition.md).[getInputsOfMethod](Condition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[Condition](Condition.md).[getSignatureOfMethod](Condition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[hashValues](Condition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[hashValuesPlain](Condition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[Condition](Condition.md).[init](Condition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Inherited from - -[Condition](Condition.md).[instance](Condition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | `Ctx` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Inherited from - -[Condition](Condition.md).[instanceFromDDO](Condition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### params - -▸ **params**(...`args`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\> - -#### Inherited from - -[Condition](Condition.md).[params](Condition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:134](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L134) - -___ - -### paramsFromDDO - -▸ `Abstract` **paramsFromDDO**(`ctx`, ...`args`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ctx` | `Ctx` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\>\> - -#### Inherited from - -[Condition](Condition.md).[paramsFromDDO](Condition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L149) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[send](Condition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[sendFrom](Condition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[Condition](Condition.md).[setInstanceConfig](Condition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[Condition](Condition.md).[addressesStatic](Condition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[Condition](Condition.md).[findSignerStatic](Condition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**<`Ctx`, `Extra`\>(`config`, `conditionName`, `conditionsClass`, `optional?`): `Promise`<`any`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Extra` | - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `conditionName` | `string` | `undefined` | -| `conditionsClass` | `any` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[Condition](Condition.md).[getInstance](Condition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:121](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L121) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[Condition](Condition.md).[setInstanceConfig](Condition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.DistributeNFTCollateralCondition.md b/docs/nevermined-sdk/api-reference/classes/conditions.DistributeNFTCollateralCondition.md deleted file mode 100644 index 8940c86511..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.DistributeNFTCollateralCondition.md +++ /dev/null @@ -1,1127 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / DistributeNFTCollateralCondition - -# Class: DistributeNFTCollateralCondition - -[conditions](../modules/conditions.md).DistributeNFTCollateralCondition - -Condition allowing to transfer an NFT either to the original owner or a lender -depending on the loan status. - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`DistributeNFTCollateralConditionContext`\> - - ↳ **`DistributeNFTCollateralCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.DistributeNFTCollateralCondition.md#constructor) - -### Properties - -- [contract](conditions.DistributeNFTCollateralCondition.md#contract) -- [contractName](conditions.DistributeNFTCollateralCondition.md#contractname) -- [events](conditions.DistributeNFTCollateralCondition.md#events) -- [version](conditions.DistributeNFTCollateralCondition.md#version) - -### Accessors - -- [address](conditions.DistributeNFTCollateralCondition.md#address) -- [artifactsFolder](conditions.DistributeNFTCollateralCondition.md#artifactsfolder) -- [config](conditions.DistributeNFTCollateralCondition.md#config) -- [instanceConfig](conditions.DistributeNFTCollateralCondition.md#instanceconfig) -- [instantiableConfig](conditions.DistributeNFTCollateralCondition.md#instantiableconfig) -- [logger](conditions.DistributeNFTCollateralCondition.md#logger) -- [nevermined](conditions.DistributeNFTCollateralCondition.md#nevermined) -- [web3](conditions.DistributeNFTCollateralCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.DistributeNFTCollateralCondition.md#abortbytimeout) -- [addresses](conditions.DistributeNFTCollateralCondition.md#addresses) -- [call](conditions.DistributeNFTCollateralCondition.md#call) -- [checkExists](conditions.DistributeNFTCollateralCondition.md#checkexists) -- [findSigner](conditions.DistributeNFTCollateralCondition.md#findsigner) -- [fulfill](conditions.DistributeNFTCollateralCondition.md#fulfill) -- [fulfillGateway](conditions.DistributeNFTCollateralCondition.md#fulfillgateway) -- [fulfillInstance](conditions.DistributeNFTCollateralCondition.md#fulfillinstance) -- [fulfillPlain](conditions.DistributeNFTCollateralCondition.md#fulfillplain) -- [gatewayMethod](conditions.DistributeNFTCollateralCondition.md#gatewaymethod) -- [generateId](conditions.DistributeNFTCollateralCondition.md#generateid) -- [generateIdHash](conditions.DistributeNFTCollateralCondition.md#generateidhash) -- [generateIdWithSeed](conditions.DistributeNFTCollateralCondition.md#generateidwithseed) -- [getAddress](conditions.DistributeNFTCollateralCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.DistributeNFTCollateralCondition.md#getconditionfulfilledevent) -- [getContract](conditions.DistributeNFTCollateralCondition.md#getcontract) -- [getFromAddress](conditions.DistributeNFTCollateralCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.DistributeNFTCollateralCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.DistributeNFTCollateralCondition.md#getsignatureofmethod) -- [hashValues](conditions.DistributeNFTCollateralCondition.md#hashvalues) -- [hashValuesPlain](conditions.DistributeNFTCollateralCondition.md#hashvaluesplain) -- [init](conditions.DistributeNFTCollateralCondition.md#init) -- [instance](conditions.DistributeNFTCollateralCondition.md#instance) -- [instanceFromDDO](conditions.DistributeNFTCollateralCondition.md#instancefromddo) -- [params](conditions.DistributeNFTCollateralCondition.md#params) -- [paramsFromDDO](conditions.DistributeNFTCollateralCondition.md#paramsfromddo) -- [send](conditions.DistributeNFTCollateralCondition.md#send) -- [sendFrom](conditions.DistributeNFTCollateralCondition.md#sendfrom) -- [setInstanceConfig](conditions.DistributeNFTCollateralCondition.md#setinstanceconfig) -- [addressesStatic](conditions.DistributeNFTCollateralCondition.md#addressesstatic) -- [findSignerStatic](conditions.DistributeNFTCollateralCondition.md#findsignerstatic) -- [getInstance](conditions.DistributeNFTCollateralCondition.md#getinstance) -- [setInstanceConfig](conditions.DistributeNFTCollateralCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new DistributeNFTCollateralCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `vaultAddress`, `nftContractAddress`, `from?`, `txParams?`): `Promise`<`ContractReceipt`\> - -Fulfill the distribute NFT collateral condition. - Only the borrower or the lender can call this method. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | The agreement identifier. | -| `did` | `string` | The DID of the asset with NFTs. | -| `vaultAddress` | `string` | The address of the vault contract where the NFT is locked. | -| `nftContractAddress` | `string` | The address of the NFT721 contract | -| `from?` | [`Account`](Account.md) | | -| `txParams?` | `TxParameters` | - | - -#### Returns - -`Promise`<`ContractReceipt`\> - -Condition state. - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts:62](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts#L62) - -___ - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | `DistributeNFTCollateralConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### params - -▸ **params**(`did`, `vaultAddress`, `nftContractAddress`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Generates the ash of condition inputs. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | The DID of the asset with NFTs. | -| `vaultAddress` | `string` | The address of the vault contract where the NFT is locked. | -| `nftContractAddress` | `string` | The address of the NFT721 contract | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Hash of all the values - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts:39](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts#L39) - -___ - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `DistributeNFTCollateralConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts:43](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts#L43) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`DistributeNFTCollateralCondition`](conditions.DistributeNFTCollateralCondition.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`DistributeNFTCollateralCondition`](conditions.DistributeNFTCollateralCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts#L21) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.EscrowPaymentCondition.md b/docs/nevermined-sdk/api-reference/classes/conditions.EscrowPaymentCondition.md deleted file mode 100644 index 94259419ec..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.EscrowPaymentCondition.md +++ /dev/null @@ -1,1127 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / EscrowPaymentCondition - -# Class: EscrowPaymentCondition - -[conditions](../modules/conditions.md).EscrowPaymentCondition - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`EscrowPaymentConditionContext`\> - - ↳ **`EscrowPaymentCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.EscrowPaymentCondition.md#constructor) - -### Properties - -- [contract](conditions.EscrowPaymentCondition.md#contract) -- [contractName](conditions.EscrowPaymentCondition.md#contractname) -- [events](conditions.EscrowPaymentCondition.md#events) -- [version](conditions.EscrowPaymentCondition.md#version) - -### Accessors - -- [address](conditions.EscrowPaymentCondition.md#address) -- [artifactsFolder](conditions.EscrowPaymentCondition.md#artifactsfolder) -- [config](conditions.EscrowPaymentCondition.md#config) -- [instanceConfig](conditions.EscrowPaymentCondition.md#instanceconfig) -- [instantiableConfig](conditions.EscrowPaymentCondition.md#instantiableconfig) -- [logger](conditions.EscrowPaymentCondition.md#logger) -- [nevermined](conditions.EscrowPaymentCondition.md#nevermined) -- [web3](conditions.EscrowPaymentCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.EscrowPaymentCondition.md#abortbytimeout) -- [addresses](conditions.EscrowPaymentCondition.md#addresses) -- [call](conditions.EscrowPaymentCondition.md#call) -- [checkExists](conditions.EscrowPaymentCondition.md#checkexists) -- [findSigner](conditions.EscrowPaymentCondition.md#findsigner) -- [fulfill](conditions.EscrowPaymentCondition.md#fulfill) -- [fulfillGateway](conditions.EscrowPaymentCondition.md#fulfillgateway) -- [fulfillInstance](conditions.EscrowPaymentCondition.md#fulfillinstance) -- [fulfillPlain](conditions.EscrowPaymentCondition.md#fulfillplain) -- [gatewayMethod](conditions.EscrowPaymentCondition.md#gatewaymethod) -- [generateId](conditions.EscrowPaymentCondition.md#generateid) -- [generateIdHash](conditions.EscrowPaymentCondition.md#generateidhash) -- [generateIdWithSeed](conditions.EscrowPaymentCondition.md#generateidwithseed) -- [getAddress](conditions.EscrowPaymentCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.EscrowPaymentCondition.md#getconditionfulfilledevent) -- [getContract](conditions.EscrowPaymentCondition.md#getcontract) -- [getFromAddress](conditions.EscrowPaymentCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.EscrowPaymentCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.EscrowPaymentCondition.md#getsignatureofmethod) -- [hashValues](conditions.EscrowPaymentCondition.md#hashvalues) -- [hashValuesPlain](conditions.EscrowPaymentCondition.md#hashvaluesplain) -- [init](conditions.EscrowPaymentCondition.md#init) -- [instance](conditions.EscrowPaymentCondition.md#instance) -- [instanceFromDDO](conditions.EscrowPaymentCondition.md#instancefromddo) -- [params](conditions.EscrowPaymentCondition.md#params) -- [paramsFromDDO](conditions.EscrowPaymentCondition.md#paramsfromddo) -- [send](conditions.EscrowPaymentCondition.md#send) -- [sendFrom](conditions.EscrowPaymentCondition.md#sendfrom) -- [setInstanceConfig](conditions.EscrowPaymentCondition.md#setinstanceconfig) -- [addressesStatic](conditions.EscrowPaymentCondition.md#addressesstatic) -- [findSignerStatic](conditions.EscrowPaymentCondition.md#findsignerstatic) -- [getInstance](conditions.EscrowPaymentCondition.md#getinstance) -- [setInstanceConfig](conditions.EscrowPaymentCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new EscrowPaymentCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `amounts`, `receivers`, `returnAddress`, `lockPaymentAddress`, `tokenAddress`, `lockCondition`, `releaseCondition`, `from?`, `txParams?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `amounts` | `default`[] | -| `receivers` | `string`[] | -| `returnAddress` | `string` | -| `lockPaymentAddress` | `string` | -| `tokenAddress` | `string` | -| `lockCondition` | `string` | -| `releaseCondition` | `string` | -| `from?` | [`Account`](Account.md) | -| `txParams?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:68](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L68) - -___ - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | `EscrowPaymentConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### params - -▸ **params**(`did`, `amounts`, `receivers`, `returnAddress`, `sender`, `tokenAddress`, `lockCondition`, `releaseCondition`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `amounts` | `default`[] | -| `receivers` | `string`[] | -| `returnAddress` | `string` | -| `sender` | `string` | -| `tokenAddress` | `string` | -| `lockCondition` | `string` | -| `releaseCondition` | `string` | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L28) - -___ - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`, `access`, `lock`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `EscrowPaymentConditionContext` | -| `access` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md) | -| `lock` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md) | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:49](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L49) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:18](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L18) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.LockPaymentCondition.md b/docs/nevermined-sdk/api-reference/classes/conditions.LockPaymentCondition.md deleted file mode 100644 index bd55a29842..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.LockPaymentCondition.md +++ /dev/null @@ -1,1100 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / LockPaymentCondition - -# Class: LockPaymentCondition - -[conditions](../modules/conditions.md).LockPaymentCondition - -## Hierarchy - -- [`ConsumerCondition`](conditions.ConsumerCondition.md)<[`ConditionContext`](../interfaces/conditions.ConditionContext.md)\> - - ↳ **`LockPaymentCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.LockPaymentCondition.md#constructor) - -### Properties - -- [contract](conditions.LockPaymentCondition.md#contract) -- [contractName](conditions.LockPaymentCondition.md#contractname) -- [events](conditions.LockPaymentCondition.md#events) -- [version](conditions.LockPaymentCondition.md#version) - -### Accessors - -- [address](conditions.LockPaymentCondition.md#address) -- [artifactsFolder](conditions.LockPaymentCondition.md#artifactsfolder) -- [config](conditions.LockPaymentCondition.md#config) -- [instanceConfig](conditions.LockPaymentCondition.md#instanceconfig) -- [instantiableConfig](conditions.LockPaymentCondition.md#instantiableconfig) -- [logger](conditions.LockPaymentCondition.md#logger) -- [nevermined](conditions.LockPaymentCondition.md#nevermined) -- [web3](conditions.LockPaymentCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.LockPaymentCondition.md#abortbytimeout) -- [addresses](conditions.LockPaymentCondition.md#addresses) -- [call](conditions.LockPaymentCondition.md#call) -- [checkExists](conditions.LockPaymentCondition.md#checkexists) -- [findSigner](conditions.LockPaymentCondition.md#findsigner) -- [fulfill](conditions.LockPaymentCondition.md#fulfill) -- [fulfillGateway](conditions.LockPaymentCondition.md#fulfillgateway) -- [fulfillInstance](conditions.LockPaymentCondition.md#fulfillinstance) -- [fulfillPlain](conditions.LockPaymentCondition.md#fulfillplain) -- [generateId](conditions.LockPaymentCondition.md#generateid) -- [generateIdHash](conditions.LockPaymentCondition.md#generateidhash) -- [generateIdWithSeed](conditions.LockPaymentCondition.md#generateidwithseed) -- [getAddress](conditions.LockPaymentCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.LockPaymentCondition.md#getconditionfulfilledevent) -- [getContract](conditions.LockPaymentCondition.md#getcontract) -- [getFromAddress](conditions.LockPaymentCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.LockPaymentCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.LockPaymentCondition.md#getsignatureofmethod) -- [hashValues](conditions.LockPaymentCondition.md#hashvalues) -- [hashValuesPlain](conditions.LockPaymentCondition.md#hashvaluesplain) -- [init](conditions.LockPaymentCondition.md#init) -- [instance](conditions.LockPaymentCondition.md#instance) -- [instanceFromDDO](conditions.LockPaymentCondition.md#instancefromddo) -- [params](conditions.LockPaymentCondition.md#params) -- [paramsFromDDO](conditions.LockPaymentCondition.md#paramsfromddo) -- [send](conditions.LockPaymentCondition.md#send) -- [sendFrom](conditions.LockPaymentCondition.md#sendfrom) -- [setInstanceConfig](conditions.LockPaymentCondition.md#setinstanceconfig) -- [addressesStatic](conditions.LockPaymentCondition.md#addressesstatic) -- [findSignerStatic](conditions.LockPaymentCondition.md#findsignerstatic) -- [getInstance](conditions.LockPaymentCondition.md#getinstance) -- [setInstanceConfig](conditions.LockPaymentCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new LockPaymentCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[constructor](conditions.ConsumerCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[contract](conditions.ConsumerCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[contractName](conditions.ConsumerCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[events](conditions.ConsumerCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[version](conditions.ConsumerCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ConsumerCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ConsumerCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ConsumerCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ConsumerCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ConsumerCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ConsumerCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ConsumerCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ConsumerCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[abortByTimeOut](conditions.ConsumerCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[addresses](conditions.ConsumerCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[call](conditions.ConsumerCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[checkExists](conditions.ConsumerCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[findSigner](conditions.ConsumerCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `default`[] | -| `receivers` | `string`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfill](conditions.ConsumerCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/LockPaymentCondition.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/LockPaymentCondition.ts#L44) - -___ - -### fulfillGateway - -▸ **fulfillGateway**(`_cond`, `_additionalParams`, `_from?`, `_params?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `_additionalParams` | `Record`<`string`, `unknown`\> | -| `_from?` | [`Account`](Account.md) | -| `_params?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillGateway](conditions.ConsumerCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:230](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L230) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillInstance](conditions.ConsumerCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillPlain](conditions.ConsumerCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateId](conditions.ConsumerCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateIdHash](conditions.ConsumerCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateIdWithSeed](conditions.ConsumerCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getAddress](conditions.ConsumerCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getConditionFulfilledEvent](conditions.ConsumerCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getContract](conditions.ConsumerCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getFromAddress](conditions.ConsumerCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getInputsOfMethod](conditions.ConsumerCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getSignatureOfMethod](conditions.ConsumerCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[hashValues](conditions.ConsumerCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[hashValuesPlain](conditions.ConsumerCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[init](conditions.ConsumerCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[instance](conditions.ConsumerCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[instanceFromDDO](conditions.ConsumerCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### params - -▸ **params**(`did`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `default`[] | -| `receivers` | `string`[] | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[params](conditions.ConsumerCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/LockPaymentCondition.ts:15](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/LockPaymentCondition.ts#L15) - -___ - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[paramsFromDDO](conditions.ConsumerCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/LockPaymentCondition.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/LockPaymentCondition.ts#L33) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[send](conditions.ConsumerCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[sendFrom](conditions.ConsumerCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[addressesStatic](conditions.ConsumerCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[findSignerStatic](conditions.ConsumerCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`LockPaymentCondition`](conditions.LockPaymentCondition.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`LockPaymentCondition`](conditions.LockPaymentCondition.md)\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[getInstance](conditions.ConsumerCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/LockPaymentCondition.ts:9](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/LockPaymentCondition.ts#L9) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.NFT721HolderCondition.md b/docs/nevermined-sdk/api-reference/classes/conditions.NFT721HolderCondition.md deleted file mode 100644 index f33ea48fd8..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.NFT721HolderCondition.md +++ /dev/null @@ -1,1127 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / NFT721HolderCondition - -# Class: NFT721HolderCondition - -[conditions](../modules/conditions.md).NFT721HolderCondition - -Allows to fulfill a condition to users holding some amount of NFTs for a specific DID. - -## Hierarchy - -- [`ConsumerCondition`](conditions.ConsumerCondition.md)<`NFT721HolderConditionContext`\> - - ↳ **`NFT721HolderCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.NFT721HolderCondition.md#constructor) - -### Properties - -- [contract](conditions.NFT721HolderCondition.md#contract) -- [contractName](conditions.NFT721HolderCondition.md#contractname) -- [events](conditions.NFT721HolderCondition.md#events) -- [version](conditions.NFT721HolderCondition.md#version) - -### Accessors - -- [address](conditions.NFT721HolderCondition.md#address) -- [artifactsFolder](conditions.NFT721HolderCondition.md#artifactsfolder) -- [config](conditions.NFT721HolderCondition.md#config) -- [instanceConfig](conditions.NFT721HolderCondition.md#instanceconfig) -- [instantiableConfig](conditions.NFT721HolderCondition.md#instantiableconfig) -- [logger](conditions.NFT721HolderCondition.md#logger) -- [nevermined](conditions.NFT721HolderCondition.md#nevermined) -- [web3](conditions.NFT721HolderCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.NFT721HolderCondition.md#abortbytimeout) -- [addresses](conditions.NFT721HolderCondition.md#addresses) -- [call](conditions.NFT721HolderCondition.md#call) -- [checkExists](conditions.NFT721HolderCondition.md#checkexists) -- [findSigner](conditions.NFT721HolderCondition.md#findsigner) -- [fulfill](conditions.NFT721HolderCondition.md#fulfill) -- [fulfillGateway](conditions.NFT721HolderCondition.md#fulfillgateway) -- [fulfillInstance](conditions.NFT721HolderCondition.md#fulfillinstance) -- [fulfillPlain](conditions.NFT721HolderCondition.md#fulfillplain) -- [generateId](conditions.NFT721HolderCondition.md#generateid) -- [generateIdHash](conditions.NFT721HolderCondition.md#generateidhash) -- [generateIdWithSeed](conditions.NFT721HolderCondition.md#generateidwithseed) -- [getAddress](conditions.NFT721HolderCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.NFT721HolderCondition.md#getconditionfulfilledevent) -- [getContract](conditions.NFT721HolderCondition.md#getcontract) -- [getFromAddress](conditions.NFT721HolderCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.NFT721HolderCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.NFT721HolderCondition.md#getsignatureofmethod) -- [hashValues](conditions.NFT721HolderCondition.md#hashvalues) -- [hashValuesPlain](conditions.NFT721HolderCondition.md#hashvaluesplain) -- [init](conditions.NFT721HolderCondition.md#init) -- [instance](conditions.NFT721HolderCondition.md#instance) -- [instanceFromDDO](conditions.NFT721HolderCondition.md#instancefromddo) -- [nftContractFromService](conditions.NFT721HolderCondition.md#nftcontractfromservice) -- [params](conditions.NFT721HolderCondition.md#params) -- [paramsFromDDO](conditions.NFT721HolderCondition.md#paramsfromddo) -- [send](conditions.NFT721HolderCondition.md#send) -- [sendFrom](conditions.NFT721HolderCondition.md#sendfrom) -- [setInstanceConfig](conditions.NFT721HolderCondition.md#setinstanceconfig) -- [addressesStatic](conditions.NFT721HolderCondition.md#addressesstatic) -- [findSignerStatic](conditions.NFT721HolderCondition.md#findsignerstatic) -- [getInstance](conditions.NFT721HolderCondition.md#getinstance) -- [setInstanceConfig](conditions.NFT721HolderCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new NFT721HolderCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[constructor](conditions.ConsumerCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[contract](conditions.ConsumerCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[contractName](conditions.ConsumerCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[events](conditions.ConsumerCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[version](conditions.ConsumerCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ConsumerCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ConsumerCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ConsumerCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ConsumerCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ConsumerCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ConsumerCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ConsumerCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ConsumerCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[abortByTimeOut](conditions.ConsumerCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[addresses](conditions.ConsumerCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[call](conditions.ConsumerCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[checkExists](conditions.ConsumerCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[findSigner](conditions.ConsumerCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `holderAddress`, `nftTokenAddress`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -Fulfill requires a validation that holder as enough NFTs for a specific DID. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | SEA agreement identifier. | -| `did` | `string` | The Decentralized Identifier of the asset. | -| `holderAddress` | `string` | The contract address where the reward is locked. | -| `nftTokenAddress` | `string` | The contract address of the nft to use. | -| `from?` | [`Account`](Account.md) | | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`ContractReceipt`\> - -condition state - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfill](conditions.ConsumerCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:71](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L71) - -___ - -### fulfillGateway - -▸ **fulfillGateway**(`_cond`, `_additionalParams`, `_from?`, `_params?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `_additionalParams` | `Record`<`string`, `unknown`\> | -| `_from?` | [`Account`](Account.md) | -| `_params?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillGateway](conditions.ConsumerCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:230](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L230) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillInstance](conditions.ConsumerCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillPlain](conditions.ConsumerCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateId](conditions.ConsumerCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateIdHash](conditions.ConsumerCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateIdWithSeed](conditions.ConsumerCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getAddress](conditions.ConsumerCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getConditionFulfilledEvent](conditions.ConsumerCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getContract](conditions.ConsumerCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getFromAddress](conditions.ConsumerCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getInputsOfMethod](conditions.ConsumerCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getSignatureOfMethod](conditions.ConsumerCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[hashValues](conditions.ConsumerCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[hashValuesPlain](conditions.ConsumerCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[init](conditions.ConsumerCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[instance](conditions.ConsumerCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | `NFT721HolderConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[instanceFromDDO](conditions.ConsumerCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### nftContractFromService - -▸ **nftContractFromService**(`service`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `service` | `ServiceCommon` | - -#### Returns - -`string` - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L44) - -___ - -### params - -▸ **params**(`did`, `holderAddress`, `nftTokenAddress`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Generate the hash of condition inputs with the following parameters. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | The Decentralized Identifier of the asset. | -| `holderAddress` | `string` | The address of the NFT holder . | -| `nftTokenAddress` | `string` | The address of the nft 721 token to use | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -hash of all the values - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[params](conditions.ConsumerCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L35) - -___ - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `NFT721HolderConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[paramsFromDDO](conditions.ConsumerCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L50) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[send](conditions.ConsumerCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[sendFrom](conditions.ConsumerCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[addressesStatic](conditions.ConsumerCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[findSignerStatic](conditions.ConsumerCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`NFT721HolderCondition`](conditions.NFT721HolderCondition.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`NFT721HolderCondition`](conditions.NFT721HolderCondition.md)\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[getInstance](conditions.ConsumerCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:16](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L16) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.NFT721LockCondition.md b/docs/nevermined-sdk/api-reference/classes/conditions.NFT721LockCondition.md deleted file mode 100644 index f125d69caa..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.NFT721LockCondition.md +++ /dev/null @@ -1,1126 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / NFT721LockCondition - -# Class: NFT721LockCondition - -[conditions](../modules/conditions.md).NFT721LockCondition - -Implementation of the NFT Lock Condition - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`NFT721LockConditionContext`\> - - ↳ **`NFT721LockCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.NFT721LockCondition.md#constructor) - -### Properties - -- [contract](conditions.NFT721LockCondition.md#contract) -- [contractName](conditions.NFT721LockCondition.md#contractname) -- [events](conditions.NFT721LockCondition.md#events) -- [version](conditions.NFT721LockCondition.md#version) - -### Accessors - -- [address](conditions.NFT721LockCondition.md#address) -- [artifactsFolder](conditions.NFT721LockCondition.md#artifactsfolder) -- [config](conditions.NFT721LockCondition.md#config) -- [instanceConfig](conditions.NFT721LockCondition.md#instanceconfig) -- [instantiableConfig](conditions.NFT721LockCondition.md#instantiableconfig) -- [logger](conditions.NFT721LockCondition.md#logger) -- [nevermined](conditions.NFT721LockCondition.md#nevermined) -- [web3](conditions.NFT721LockCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.NFT721LockCondition.md#abortbytimeout) -- [addresses](conditions.NFT721LockCondition.md#addresses) -- [call](conditions.NFT721LockCondition.md#call) -- [checkExists](conditions.NFT721LockCondition.md#checkexists) -- [findSigner](conditions.NFT721LockCondition.md#findsigner) -- [fulfill](conditions.NFT721LockCondition.md#fulfill) -- [fulfillGateway](conditions.NFT721LockCondition.md#fulfillgateway) -- [fulfillInstance](conditions.NFT721LockCondition.md#fulfillinstance) -- [fulfillPlain](conditions.NFT721LockCondition.md#fulfillplain) -- [gatewayMethod](conditions.NFT721LockCondition.md#gatewaymethod) -- [generateId](conditions.NFT721LockCondition.md#generateid) -- [generateIdHash](conditions.NFT721LockCondition.md#generateidhash) -- [generateIdWithSeed](conditions.NFT721LockCondition.md#generateidwithseed) -- [getAddress](conditions.NFT721LockCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.NFT721LockCondition.md#getconditionfulfilledevent) -- [getContract](conditions.NFT721LockCondition.md#getcontract) -- [getFromAddress](conditions.NFT721LockCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.NFT721LockCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.NFT721LockCondition.md#getsignatureofmethod) -- [hashValues](conditions.NFT721LockCondition.md#hashvalues) -- [hashValuesPlain](conditions.NFT721LockCondition.md#hashvaluesplain) -- [init](conditions.NFT721LockCondition.md#init) -- [instance](conditions.NFT721LockCondition.md#instance) -- [instanceFromDDO](conditions.NFT721LockCondition.md#instancefromddo) -- [params](conditions.NFT721LockCondition.md#params) -- [paramsFromDDO](conditions.NFT721LockCondition.md#paramsfromddo) -- [send](conditions.NFT721LockCondition.md#send) -- [sendFrom](conditions.NFT721LockCondition.md#sendfrom) -- [setInstanceConfig](conditions.NFT721LockCondition.md#setinstanceconfig) -- [addressesStatic](conditions.NFT721LockCondition.md#addressesstatic) -- [findSignerStatic](conditions.NFT721LockCondition.md#findsignerstatic) -- [getInstance](conditions.NFT721LockCondition.md#getinstance) -- [setInstanceConfig](conditions.NFT721LockCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new NFT721LockCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `lockAddress`, `amount`, `nftContractAddress`, `from?`): `Promise`<`ContractReceipt`\> - -Fulfill requires valid NFT transfer in order to lock the amount of DID NFTs based on SEA. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | SEA agreement identifier. | -| `did` | `string` | Asset Decentralized identifier. | -| `lockAddress` | `string` | The contract address where the NFT is locked. | -| `amount` | `number` | The amount of tokens to be locked. | -| `nftContractAddress` | `string` | The NFT721 contract address | -| `from?` | [`Account`](Account.md) | | - -#### Returns - -`Promise`<`ContractReceipt`\> - -Condition state. - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/defi/NFT721LockCondition.ts:72](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/NFT721LockCondition.ts#L72) - -___ - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | `NFT721LockConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### params - -▸ **params**(`did`, `lockAddress`, `amount`, `nftContractAddress`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Generates the hash of condition inputs. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | The DID of the asset with NFTs attached to lock. | -| `lockAddress` | `string` | the address to lock the NFT to (vault address) | -| `amount` | `number` | The amount of locked tokens. | -| `nftContractAddress` | `string` | The NFT721 contract address | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Hash of all the values. - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/defi/NFT721LockCondition.ts:39](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/NFT721LockCondition.ts#L39) - -___ - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `NFT721LockConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/defi/NFT721LockCondition.ts:53](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/NFT721LockCondition.ts#L53) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`NFT721LockCondition`](conditions.NFT721LockCondition.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`NFT721LockCondition`](conditions.NFT721LockCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/defi/NFT721LockCondition.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/NFT721LockCondition.ts#L20) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.NFTAccessCondition.md b/docs/nevermined-sdk/api-reference/classes/conditions.NFTAccessCondition.md deleted file mode 100644 index 1e25ec5585..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.NFTAccessCondition.md +++ /dev/null @@ -1,1136 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / NFTAccessCondition - -# Class: NFTAccessCondition - -[conditions](../modules/conditions.md).NFTAccessCondition - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`NFTAccessConditionContext`\> - - ↳ **`NFTAccessCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.NFTAccessCondition.md#constructor) - -### Properties - -- [contract](conditions.NFTAccessCondition.md#contract) -- [contractName](conditions.NFTAccessCondition.md#contractname) -- [events](conditions.NFTAccessCondition.md#events) -- [version](conditions.NFTAccessCondition.md#version) - -### Accessors - -- [address](conditions.NFTAccessCondition.md#address) -- [artifactsFolder](conditions.NFTAccessCondition.md#artifactsfolder) -- [config](conditions.NFTAccessCondition.md#config) -- [instanceConfig](conditions.NFTAccessCondition.md#instanceconfig) -- [instantiableConfig](conditions.NFTAccessCondition.md#instantiableconfig) -- [logger](conditions.NFTAccessCondition.md#logger) -- [nevermined](conditions.NFTAccessCondition.md#nevermined) -- [web3](conditions.NFTAccessCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.NFTAccessCondition.md#abortbytimeout) -- [addresses](conditions.NFTAccessCondition.md#addresses) -- [call](conditions.NFTAccessCondition.md#call) -- [checkExists](conditions.NFTAccessCondition.md#checkexists) -- [checkPermissions](conditions.NFTAccessCondition.md#checkpermissions) -- [findSigner](conditions.NFTAccessCondition.md#findsigner) -- [fulfill](conditions.NFTAccessCondition.md#fulfill) -- [fulfillGateway](conditions.NFTAccessCondition.md#fulfillgateway) -- [fulfillInstance](conditions.NFTAccessCondition.md#fulfillinstance) -- [fulfillPlain](conditions.NFTAccessCondition.md#fulfillplain) -- [gatewayMethod](conditions.NFTAccessCondition.md#gatewaymethod) -- [generateId](conditions.NFTAccessCondition.md#generateid) -- [generateIdHash](conditions.NFTAccessCondition.md#generateidhash) -- [generateIdWithSeed](conditions.NFTAccessCondition.md#generateidwithseed) -- [getAddress](conditions.NFTAccessCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.NFTAccessCondition.md#getconditionfulfilledevent) -- [getContract](conditions.NFTAccessCondition.md#getcontract) -- [getFromAddress](conditions.NFTAccessCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.NFTAccessCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.NFTAccessCondition.md#getsignatureofmethod) -- [hashValues](conditions.NFTAccessCondition.md#hashvalues) -- [hashValuesPlain](conditions.NFTAccessCondition.md#hashvaluesplain) -- [init](conditions.NFTAccessCondition.md#init) -- [instance](conditions.NFTAccessCondition.md#instance) -- [instanceFromDDO](conditions.NFTAccessCondition.md#instancefromddo) -- [params](conditions.NFTAccessCondition.md#params) -- [paramsFromDDO](conditions.NFTAccessCondition.md#paramsfromddo) -- [send](conditions.NFTAccessCondition.md#send) -- [sendFrom](conditions.NFTAccessCondition.md#sendfrom) -- [setInstanceConfig](conditions.NFTAccessCondition.md#setinstanceconfig) -- [addressesStatic](conditions.NFTAccessCondition.md#addressesstatic) -- [findSignerStatic](conditions.NFTAccessCondition.md#findsignerstatic) -- [getInstance](conditions.NFTAccessCondition.md#getinstance) -- [setInstanceConfig](conditions.NFTAccessCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new NFTAccessCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### checkPermissions - -▸ **checkPermissions**(`grantee`, `did`, `from?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `grantee` | `string` | -| `did` | `string` | -| `from?` | [`Account`](Account.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L41) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `grantee`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `grantee` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L26) - -___ - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | `NFTAccessConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### params - -▸ **params**(`did`, `grantee`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `grantee` | `string` | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:18](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L18) - -___ - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `NFTAccessConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:22](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L22) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`NFTAccessCondition`](conditions.NFTAccessCondition.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`NFTAccessCondition`](conditions.NFTAccessCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L12) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.NFTHolderCondition.md b/docs/nevermined-sdk/api-reference/classes/conditions.NFTHolderCondition.md deleted file mode 100644 index cf4368dfcc..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.NFTHolderCondition.md +++ /dev/null @@ -1,1127 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / NFTHolderCondition - -# Class: NFTHolderCondition - -[conditions](../modules/conditions.md).NFTHolderCondition - -Allows to fulfill a condition to users holding some amount of NFTs for a specific DID. - -## Hierarchy - -- [`ConsumerCondition`](conditions.ConsumerCondition.md)<`NFTHolderConditionContext`\> - - ↳ **`NFTHolderCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.NFTHolderCondition.md#constructor) - -### Properties - -- [contract](conditions.NFTHolderCondition.md#contract) -- [contractName](conditions.NFTHolderCondition.md#contractname) -- [events](conditions.NFTHolderCondition.md#events) -- [version](conditions.NFTHolderCondition.md#version) - -### Accessors - -- [address](conditions.NFTHolderCondition.md#address) -- [artifactsFolder](conditions.NFTHolderCondition.md#artifactsfolder) -- [config](conditions.NFTHolderCondition.md#config) -- [instanceConfig](conditions.NFTHolderCondition.md#instanceconfig) -- [instantiableConfig](conditions.NFTHolderCondition.md#instantiableconfig) -- [logger](conditions.NFTHolderCondition.md#logger) -- [nevermined](conditions.NFTHolderCondition.md#nevermined) -- [web3](conditions.NFTHolderCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.NFTHolderCondition.md#abortbytimeout) -- [addresses](conditions.NFTHolderCondition.md#addresses) -- [amountFromService](conditions.NFTHolderCondition.md#amountfromservice) -- [call](conditions.NFTHolderCondition.md#call) -- [checkExists](conditions.NFTHolderCondition.md#checkexists) -- [findSigner](conditions.NFTHolderCondition.md#findsigner) -- [fulfill](conditions.NFTHolderCondition.md#fulfill) -- [fulfillGateway](conditions.NFTHolderCondition.md#fulfillgateway) -- [fulfillInstance](conditions.NFTHolderCondition.md#fulfillinstance) -- [fulfillPlain](conditions.NFTHolderCondition.md#fulfillplain) -- [generateId](conditions.NFTHolderCondition.md#generateid) -- [generateIdHash](conditions.NFTHolderCondition.md#generateidhash) -- [generateIdWithSeed](conditions.NFTHolderCondition.md#generateidwithseed) -- [getAddress](conditions.NFTHolderCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.NFTHolderCondition.md#getconditionfulfilledevent) -- [getContract](conditions.NFTHolderCondition.md#getcontract) -- [getFromAddress](conditions.NFTHolderCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.NFTHolderCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.NFTHolderCondition.md#getsignatureofmethod) -- [hashValues](conditions.NFTHolderCondition.md#hashvalues) -- [hashValuesPlain](conditions.NFTHolderCondition.md#hashvaluesplain) -- [init](conditions.NFTHolderCondition.md#init) -- [instance](conditions.NFTHolderCondition.md#instance) -- [instanceFromDDO](conditions.NFTHolderCondition.md#instancefromddo) -- [params](conditions.NFTHolderCondition.md#params) -- [paramsFromDDO](conditions.NFTHolderCondition.md#paramsfromddo) -- [send](conditions.NFTHolderCondition.md#send) -- [sendFrom](conditions.NFTHolderCondition.md#sendfrom) -- [setInstanceConfig](conditions.NFTHolderCondition.md#setinstanceconfig) -- [addressesStatic](conditions.NFTHolderCondition.md#addressesstatic) -- [findSignerStatic](conditions.NFTHolderCondition.md#findsignerstatic) -- [getInstance](conditions.NFTHolderCondition.md#getinstance) -- [setInstanceConfig](conditions.NFTHolderCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new NFTHolderCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[constructor](conditions.ConsumerCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[contract](conditions.ConsumerCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[contractName](conditions.ConsumerCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[events](conditions.ConsumerCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[version](conditions.ConsumerCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ConsumerCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ConsumerCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ConsumerCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ConsumerCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ConsumerCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ConsumerCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ConsumerCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ConsumerCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[abortByTimeOut](conditions.ConsumerCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[addresses](conditions.ConsumerCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### amountFromService - -▸ **amountFromService**(`service`): `default` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `service` | `ServiceCommon` | - -#### Returns - -`default` - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:36](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L36) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[call](conditions.ConsumerCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[checkExists](conditions.ConsumerCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[findSigner](conditions.ConsumerCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `holderAddress`, `amount`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -Fulfill requires a validation that holder as enough NFTs for a specific DID. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | SEA agreement identifier. | -| `did` | `string` | The Decentralized Identifier of the asset. | -| `holderAddress` | `string` | The contract address where the reward is locked. | -| `amount` | `default` | The amount of NFT to be hold | -| `from?` | [`Account`](Account.md) | | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`ContractReceipt`\> - -condition state - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfill](conditions.ConsumerCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:62](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L62) - -___ - -### fulfillGateway - -▸ **fulfillGateway**(`_cond`, `_additionalParams`, `_from?`, `_params?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `_additionalParams` | `Record`<`string`, `unknown`\> | -| `_from?` | [`Account`](Account.md) | -| `_params?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillGateway](conditions.ConsumerCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:230](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L230) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillInstance](conditions.ConsumerCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillPlain](conditions.ConsumerCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateId](conditions.ConsumerCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateIdHash](conditions.ConsumerCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateIdWithSeed](conditions.ConsumerCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getAddress](conditions.ConsumerCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getConditionFulfilledEvent](conditions.ConsumerCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getContract](conditions.ConsumerCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getFromAddress](conditions.ConsumerCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getInputsOfMethod](conditions.ConsumerCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getSignatureOfMethod](conditions.ConsumerCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[hashValues](conditions.ConsumerCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[hashValuesPlain](conditions.ConsumerCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[init](conditions.ConsumerCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[instance](conditions.ConsumerCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | `NFTHolderConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[instanceFromDDO](conditions.ConsumerCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### params - -▸ **params**(`did`, `holderAddress`, `amount?`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Generate the hash of condition inputs with the following parameters. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | The Decentralized Identifier of the asset. | -| `holderAddress` | `string` | The address of the NFT holder . | -| `amount?` | `default` | The amount of NFTs that need to be hold by the holder | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -hash of all the values - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[params](conditions.ConsumerCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L32) - -___ - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `NFTHolderConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[paramsFromDDO](conditions.ConsumerCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:42](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L42) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[send](conditions.ConsumerCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[sendFrom](conditions.ConsumerCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[addressesStatic](conditions.ConsumerCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[findSignerStatic](conditions.ConsumerCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`NFTHolderCondition`](conditions.NFTHolderCondition.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`NFTHolderCondition`](conditions.NFTHolderCondition.md)\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[getInstance](conditions.ConsumerCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:18](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L18) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.NFTLockCondition.md b/docs/nevermined-sdk/api-reference/classes/conditions.NFTLockCondition.md deleted file mode 100644 index 6305358a13..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.NFTLockCondition.md +++ /dev/null @@ -1,1106 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / NFTLockCondition - -# Class: NFTLockCondition - -[conditions](../modules/conditions.md).NFTLockCondition - -Implementation of the NFT Lock Condition - -## Hierarchy - -- [`ConsumerCondition`](conditions.ConsumerCondition.md)<`NFTLockConditionContext`\> - - ↳ **`NFTLockCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.NFTLockCondition.md#constructor) - -### Properties - -- [contract](conditions.NFTLockCondition.md#contract) -- [contractName](conditions.NFTLockCondition.md#contractname) -- [events](conditions.NFTLockCondition.md#events) -- [version](conditions.NFTLockCondition.md#version) - -### Accessors - -- [address](conditions.NFTLockCondition.md#address) -- [artifactsFolder](conditions.NFTLockCondition.md#artifactsfolder) -- [config](conditions.NFTLockCondition.md#config) -- [instanceConfig](conditions.NFTLockCondition.md#instanceconfig) -- [instantiableConfig](conditions.NFTLockCondition.md#instantiableconfig) -- [logger](conditions.NFTLockCondition.md#logger) -- [nevermined](conditions.NFTLockCondition.md#nevermined) -- [web3](conditions.NFTLockCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.NFTLockCondition.md#abortbytimeout) -- [addresses](conditions.NFTLockCondition.md#addresses) -- [call](conditions.NFTLockCondition.md#call) -- [checkExists](conditions.NFTLockCondition.md#checkexists) -- [findSigner](conditions.NFTLockCondition.md#findsigner) -- [fulfill](conditions.NFTLockCondition.md#fulfill) -- [fulfillGateway](conditions.NFTLockCondition.md#fulfillgateway) -- [fulfillInstance](conditions.NFTLockCondition.md#fulfillinstance) -- [fulfillPlain](conditions.NFTLockCondition.md#fulfillplain) -- [generateId](conditions.NFTLockCondition.md#generateid) -- [generateIdHash](conditions.NFTLockCondition.md#generateidhash) -- [generateIdWithSeed](conditions.NFTLockCondition.md#generateidwithseed) -- [getAddress](conditions.NFTLockCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.NFTLockCondition.md#getconditionfulfilledevent) -- [getContract](conditions.NFTLockCondition.md#getcontract) -- [getFromAddress](conditions.NFTLockCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.NFTLockCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.NFTLockCondition.md#getsignatureofmethod) -- [hashValues](conditions.NFTLockCondition.md#hashvalues) -- [hashValuesPlain](conditions.NFTLockCondition.md#hashvaluesplain) -- [init](conditions.NFTLockCondition.md#init) -- [instance](conditions.NFTLockCondition.md#instance) -- [instanceFromDDO](conditions.NFTLockCondition.md#instancefromddo) -- [params](conditions.NFTLockCondition.md#params) -- [paramsFromDDO](conditions.NFTLockCondition.md#paramsfromddo) -- [send](conditions.NFTLockCondition.md#send) -- [sendFrom](conditions.NFTLockCondition.md#sendfrom) -- [setInstanceConfig](conditions.NFTLockCondition.md#setinstanceconfig) -- [addressesStatic](conditions.NFTLockCondition.md#addressesstatic) -- [findSignerStatic](conditions.NFTLockCondition.md#findsignerstatic) -- [getInstance](conditions.NFTLockCondition.md#getinstance) -- [setInstanceConfig](conditions.NFTLockCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new NFTLockCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[constructor](conditions.ConsumerCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[contract](conditions.ConsumerCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[contractName](conditions.ConsumerCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[events](conditions.ConsumerCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[version](conditions.ConsumerCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ConsumerCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ConsumerCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ConsumerCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ConsumerCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ConsumerCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ConsumerCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ConsumerCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ConsumerCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[abortByTimeOut](conditions.ConsumerCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[addresses](conditions.ConsumerCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[call](conditions.ConsumerCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[checkExists](conditions.ConsumerCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[findSigner](conditions.ConsumerCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `rewardAddress`, `amount`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -Fulfill requires valid NFT transfer in order to lock the amount of DID NFTs based on SEA. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | SEA agreement identifier. | -| `did` | `string` | Asset Decentralized identifier. | -| `rewardAddress` | `string` | The contract address where the reward is locked. | -| `amount` | `default` | The amount of tokens to be transferred. | -| `from?` | [`Account`](Account.md) | | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`ContractReceipt`\> - -Condition state. - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfill](conditions.ConsumerCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:47](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L47) - -___ - -### fulfillGateway - -▸ **fulfillGateway**(`_cond`, `_additionalParams`, `_from?`, `_params?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `_additionalParams` | `Record`<`string`, `unknown`\> | -| `_from?` | [`Account`](Account.md) | -| `_params?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillGateway](conditions.ConsumerCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:230](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L230) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillInstance](conditions.ConsumerCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillPlain](conditions.ConsumerCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateId](conditions.ConsumerCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateIdHash](conditions.ConsumerCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateIdWithSeed](conditions.ConsumerCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getAddress](conditions.ConsumerCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getConditionFulfilledEvent](conditions.ConsumerCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getContract](conditions.ConsumerCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getFromAddress](conditions.ConsumerCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getInputsOfMethod](conditions.ConsumerCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getSignatureOfMethod](conditions.ConsumerCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[hashValues](conditions.ConsumerCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[hashValuesPlain](conditions.ConsumerCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[init](conditions.ConsumerCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[instance](conditions.ConsumerCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | `NFTLockConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[instanceFromDDO](conditions.ConsumerCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### params - -▸ **params**(`did`, `rewardAddress`, `amount`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Generates the hash of condition inputs. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | The DID of the asset with NFTs attached to lock. | -| `rewardAddress` | `string` | The final address to receive the NFTs. | -| `amount` | `number` | The amount of locked tokens. | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Hash of all the values. - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[params](conditions.ConsumerCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L30) - -___ - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `NFTLockConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[paramsFromDDO](conditions.ConsumerCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:34](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L34) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[send](conditions.ConsumerCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[sendFrom](conditions.ConsumerCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[addressesStatic](conditions.ConsumerCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[findSignerStatic](conditions.ConsumerCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`NFTLockCondition`](conditions.NFTLockCondition.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`NFTLockCondition`](conditions.NFTLockCondition.md)\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[getInstance](conditions.ConsumerCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:17](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L17) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.ProviderCondition.md b/docs/nevermined-sdk/api-reference/classes/conditions.ProviderCondition.md deleted file mode 100644 index 6eccb3628d..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.ProviderCondition.md +++ /dev/null @@ -1,1156 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / ProviderCondition - -# Class: ProviderCondition - -[conditions](../modules/conditions.md).ProviderCondition - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Record`<`string`, `unknown`\> | - -## Hierarchy - -- [`Condition`](Condition.md)<`Ctx`, `Extra`\> - - ↳ **`ProviderCondition`** - - ↳↳ [`AccessCondition`](conditions.AccessCondition.md) - - ↳↳ [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md) - - ↳↳ [`ComputeExecutionCondition`](conditions.ComputeExecutionCondition.md) - - ↳↳ [`NFTAccessCondition`](conditions.NFTAccessCondition.md) - - ↳↳ [`TransferNFTCondition`](conditions.TransferNFTCondition.md) - - ↳↳ [`TransferNFT721Condition`](conditions.TransferNFT721Condition.md) - - ↳↳ [`TransferDIDOwnershipCondition`](conditions.TransferDIDOwnershipCondition.md) - - ↳↳ [`AaveBorrowCondition`](conditions.AaveBorrowCondition.md) - - ↳↳ [`AaveCollateralDepositCondition`](conditions.AaveCollateralDepositCondition.md) - - ↳↳ [`AaveCollateralWithdrawCondition`](conditions.AaveCollateralWithdrawCondition.md) - - ↳↳ [`AaveRepayCondition`](conditions.AaveRepayCondition.md) - - ↳↳ [`NFT721LockCondition`](conditions.NFT721LockCondition.md) - - ↳↳ [`DistributeNFTCollateralCondition`](conditions.DistributeNFTCollateralCondition.md) - -## Table of contents - -### Constructors - -- [constructor](conditions.ProviderCondition.md#constructor) - -### Properties - -- [contract](conditions.ProviderCondition.md#contract) -- [contractName](conditions.ProviderCondition.md#contractname) -- [events](conditions.ProviderCondition.md#events) -- [version](conditions.ProviderCondition.md#version) - -### Accessors - -- [address](conditions.ProviderCondition.md#address) -- [artifactsFolder](conditions.ProviderCondition.md#artifactsfolder) -- [config](conditions.ProviderCondition.md#config) -- [instanceConfig](conditions.ProviderCondition.md#instanceconfig) -- [instantiableConfig](conditions.ProviderCondition.md#instantiableconfig) -- [logger](conditions.ProviderCondition.md#logger) -- [nevermined](conditions.ProviderCondition.md#nevermined) -- [web3](conditions.ProviderCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) -- [addresses](conditions.ProviderCondition.md#addresses) -- [call](conditions.ProviderCondition.md#call) -- [checkExists](conditions.ProviderCondition.md#checkexists) -- [findSigner](conditions.ProviderCondition.md#findsigner) -- [fulfill](conditions.ProviderCondition.md#fulfill) -- [fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) -- [fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) -- [fulfillPlain](conditions.ProviderCondition.md#fulfillplain) -- [gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) -- [generateId](conditions.ProviderCondition.md#generateid) -- [generateIdHash](conditions.ProviderCondition.md#generateidhash) -- [generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) -- [getAddress](conditions.ProviderCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) -- [getContract](conditions.ProviderCondition.md#getcontract) -- [getFromAddress](conditions.ProviderCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) -- [hashValues](conditions.ProviderCondition.md#hashvalues) -- [hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) -- [init](conditions.ProviderCondition.md#init) -- [instance](conditions.ProviderCondition.md#instance) -- [instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) -- [params](conditions.ProviderCondition.md#params) -- [paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) -- [send](conditions.ProviderCondition.md#send) -- [sendFrom](conditions.ProviderCondition.md#sendfrom) -- [setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) -- [addressesStatic](conditions.ProviderCondition.md#addressesstatic) -- [findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) -- [getInstance](conditions.ProviderCondition.md#getinstance) -- [setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new ProviderCondition**<`Ctx`, `Extra`\>(`contractName`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Record`<`string`, `unknown`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[Condition](Condition.md).[constructor](Condition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[Condition](Condition.md).[contract](Condition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[Condition](Condition.md).[contractName](Condition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[Condition](Condition.md).[events](Condition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[Condition](Condition.md).[version](Condition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -Condition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -Condition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -Condition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Condition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Condition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -Condition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -Condition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -Condition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[abortByTimeOut](Condition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[Condition](Condition.md).[addresses](Condition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[Condition](Condition.md).[call](Condition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[Condition](Condition.md).[checkExists](Condition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[Condition](Condition.md).[findSigner](Condition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ `Abstract` **fulfill**(`agreementId`, ...`args`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...args` | `any`[] | - -#### Returns - -`any` - -#### Inherited from - -[Condition](Condition.md).[fulfill](Condition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:67](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L67) - -___ - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\> | -| `additionalParams` | `Extra` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[Condition](Condition.md).[fulfillGateway](Condition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\> | `undefined` | -| `additionalParams` | `Extra` | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[fulfillInstance](Condition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[fulfillPlain](Condition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[generateId](Condition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[generateIdHash](Condition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[Condition](Condition.md).[generateIdWithSeed](Condition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[Condition](Condition.md).[getAddress](Condition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[Condition](Condition.md).[getConditionFulfilledEvent](Condition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[Condition](Condition.md).[getContract](Condition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[getFromAddress](Condition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[Condition](Condition.md).[getInputsOfMethod](Condition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[Condition](Condition.md).[getSignatureOfMethod](Condition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[hashValues](Condition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[hashValuesPlain](Condition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[Condition](Condition.md).[init](Condition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Inherited from - -[Condition](Condition.md).[instance](Condition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | `Ctx` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Inherited from - -[Condition](Condition.md).[instanceFromDDO](Condition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### params - -▸ **params**(...`args`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\> - -#### Inherited from - -[Condition](Condition.md).[params](Condition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:134](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L134) - -___ - -### paramsFromDDO - -▸ `Abstract` **paramsFromDDO**(`ctx`, ...`args`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ctx` | `Ctx` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\>\> - -#### Inherited from - -[Condition](Condition.md).[paramsFromDDO](Condition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L149) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[send](Condition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[sendFrom](Condition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[Condition](Condition.md).[setInstanceConfig](Condition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[Condition](Condition.md).[addressesStatic](Condition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[Condition](Condition.md).[findSignerStatic](Condition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**<`Ctx`, `Extra`\>(`config`, `conditionName`, `conditionsClass`, `optional?`): `Promise`<`any`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Extra` | - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `conditionName` | `string` | `undefined` | -| `conditionsClass` | `any` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[Condition](Condition.md).[getInstance](Condition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:121](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L121) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[Condition](Condition.md).[setInstanceConfig](Condition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.TransferDIDOwnershipCondition.md b/docs/nevermined-sdk/api-reference/classes/conditions.TransferDIDOwnershipCondition.md deleted file mode 100644 index c7718692cb..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.TransferDIDOwnershipCondition.md +++ /dev/null @@ -1,1128 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / TransferDIDOwnershipCondition - -# Class: TransferDIDOwnershipCondition - -[conditions](../modules/conditions.md).TransferDIDOwnershipCondition - -Condition allowing to transfer the ownership between the original owner and a receiver. - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`AccessConditionContext`\> - - ↳ **`TransferDIDOwnershipCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.TransferDIDOwnershipCondition.md#constructor) - -### Properties - -- [contract](conditions.TransferDIDOwnershipCondition.md#contract) -- [contractName](conditions.TransferDIDOwnershipCondition.md#contractname) -- [events](conditions.TransferDIDOwnershipCondition.md#events) -- [version](conditions.TransferDIDOwnershipCondition.md#version) - -### Accessors - -- [address](conditions.TransferDIDOwnershipCondition.md#address) -- [artifactsFolder](conditions.TransferDIDOwnershipCondition.md#artifactsfolder) -- [config](conditions.TransferDIDOwnershipCondition.md#config) -- [instanceConfig](conditions.TransferDIDOwnershipCondition.md#instanceconfig) -- [instantiableConfig](conditions.TransferDIDOwnershipCondition.md#instantiableconfig) -- [logger](conditions.TransferDIDOwnershipCondition.md#logger) -- [nevermined](conditions.TransferDIDOwnershipCondition.md#nevermined) -- [web3](conditions.TransferDIDOwnershipCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.TransferDIDOwnershipCondition.md#abortbytimeout) -- [addresses](conditions.TransferDIDOwnershipCondition.md#addresses) -- [call](conditions.TransferDIDOwnershipCondition.md#call) -- [checkExists](conditions.TransferDIDOwnershipCondition.md#checkexists) -- [findSigner](conditions.TransferDIDOwnershipCondition.md#findsigner) -- [fulfill](conditions.TransferDIDOwnershipCondition.md#fulfill) -- [fulfillGateway](conditions.TransferDIDOwnershipCondition.md#fulfillgateway) -- [fulfillInstance](conditions.TransferDIDOwnershipCondition.md#fulfillinstance) -- [fulfillPlain](conditions.TransferDIDOwnershipCondition.md#fulfillplain) -- [gatewayMethod](conditions.TransferDIDOwnershipCondition.md#gatewaymethod) -- [generateId](conditions.TransferDIDOwnershipCondition.md#generateid) -- [generateIdHash](conditions.TransferDIDOwnershipCondition.md#generateidhash) -- [generateIdWithSeed](conditions.TransferDIDOwnershipCondition.md#generateidwithseed) -- [getAddress](conditions.TransferDIDOwnershipCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.TransferDIDOwnershipCondition.md#getconditionfulfilledevent) -- [getContract](conditions.TransferDIDOwnershipCondition.md#getcontract) -- [getFromAddress](conditions.TransferDIDOwnershipCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.TransferDIDOwnershipCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.TransferDIDOwnershipCondition.md#getsignatureofmethod) -- [hashValues](conditions.TransferDIDOwnershipCondition.md#hashvalues) -- [hashValuesPlain](conditions.TransferDIDOwnershipCondition.md#hashvaluesplain) -- [init](conditions.TransferDIDOwnershipCondition.md#init) -- [instance](conditions.TransferDIDOwnershipCondition.md#instance) -- [instanceFromDDO](conditions.TransferDIDOwnershipCondition.md#instancefromddo) -- [params](conditions.TransferDIDOwnershipCondition.md#params) -- [paramsFromDDO](conditions.TransferDIDOwnershipCondition.md#paramsfromddo) -- [send](conditions.TransferDIDOwnershipCondition.md#send) -- [sendFrom](conditions.TransferDIDOwnershipCondition.md#sendfrom) -- [setInstanceConfig](conditions.TransferDIDOwnershipCondition.md#setinstanceconfig) -- [addressesStatic](conditions.TransferDIDOwnershipCondition.md#addressesstatic) -- [findSignerStatic](conditions.TransferDIDOwnershipCondition.md#findsignerstatic) -- [getInstance](conditions.TransferDIDOwnershipCondition.md#getinstance) -- [setInstanceConfig](conditions.TransferDIDOwnershipCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new TransferDIDOwnershipCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `receiver`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -Fulfill the transfer DID ownership condition. - -**`Remarks`** - -Only DID owner or DID provider can call this method. -Fulfill method transfer full ownership permissions to the receiver address. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement identifier. | -| `did` | `string` | The Decentralized Identifier of the asset. | -| `receiver` | `string` | The address of the granted user. | -| `from?` | [`Account`](Account.md) | | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`ContractReceipt`\> - -Condition state. - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:52](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L52) - -___ - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | `AccessConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### params - -▸ **params**(`did`, `receiver`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Generates the hash of the condition inputs. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | The Decentralized Identifier of the asset. | -| `receiver` | `string` | Address of the granted user or the DID provider. | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Hash of all the values. - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L31) - -___ - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `AccessConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L35) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`TransferDIDOwnershipCondition`](conditions.TransferDIDOwnershipCondition.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`TransferDIDOwnershipCondition`](conditions.TransferDIDOwnershipCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:15](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L15) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.TransferNFT721Condition.md b/docs/nevermined-sdk/api-reference/classes/conditions.TransferNFT721Condition.md deleted file mode 100644 index b8127b3b87..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.TransferNFT721Condition.md +++ /dev/null @@ -1,1136 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / TransferNFT721Condition - -# Class: TransferNFT721Condition - -[conditions](../modules/conditions.md).TransferNFT721Condition - -Condition allowing to transfer an NFT between the original owner and a receiver - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`TransferNFT721ConditionContext`\> - - ↳ **`TransferNFT721Condition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.TransferNFT721Condition.md#constructor) - -### Properties - -- [contract](conditions.TransferNFT721Condition.md#contract) -- [contractName](conditions.TransferNFT721Condition.md#contractname) -- [events](conditions.TransferNFT721Condition.md#events) -- [version](conditions.TransferNFT721Condition.md#version) - -### Accessors - -- [address](conditions.TransferNFT721Condition.md#address) -- [artifactsFolder](conditions.TransferNFT721Condition.md#artifactsfolder) -- [config](conditions.TransferNFT721Condition.md#config) -- [instanceConfig](conditions.TransferNFT721Condition.md#instanceconfig) -- [instantiableConfig](conditions.TransferNFT721Condition.md#instantiableconfig) -- [logger](conditions.TransferNFT721Condition.md#logger) -- [nevermined](conditions.TransferNFT721Condition.md#nevermined) -- [web3](conditions.TransferNFT721Condition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.TransferNFT721Condition.md#abortbytimeout) -- [addresses](conditions.TransferNFT721Condition.md#addresses) -- [call](conditions.TransferNFT721Condition.md#call) -- [checkExists](conditions.TransferNFT721Condition.md#checkexists) -- [findSigner](conditions.TransferNFT721Condition.md#findsigner) -- [fulfill](conditions.TransferNFT721Condition.md#fulfill) -- [fulfillGateway](conditions.TransferNFT721Condition.md#fulfillgateway) -- [fulfillInstance](conditions.TransferNFT721Condition.md#fulfillinstance) -- [fulfillPlain](conditions.TransferNFT721Condition.md#fulfillplain) -- [gatewayMethod](conditions.TransferNFT721Condition.md#gatewaymethod) -- [generateId](conditions.TransferNFT721Condition.md#generateid) -- [generateIdHash](conditions.TransferNFT721Condition.md#generateidhash) -- [generateIdWithSeed](conditions.TransferNFT721Condition.md#generateidwithseed) -- [getAddress](conditions.TransferNFT721Condition.md#getaddress) -- [getConditionFulfilledEvent](conditions.TransferNFT721Condition.md#getconditionfulfilledevent) -- [getContract](conditions.TransferNFT721Condition.md#getcontract) -- [getFromAddress](conditions.TransferNFT721Condition.md#getfromaddress) -- [getInputsOfMethod](conditions.TransferNFT721Condition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.TransferNFT721Condition.md#getsignatureofmethod) -- [hashValues](conditions.TransferNFT721Condition.md#hashvalues) -- [hashValuesPlain](conditions.TransferNFT721Condition.md#hashvaluesplain) -- [init](conditions.TransferNFT721Condition.md#init) -- [instance](conditions.TransferNFT721Condition.md#instance) -- [instanceFromDDO](conditions.TransferNFT721Condition.md#instancefromddo) -- [params](conditions.TransferNFT721Condition.md#params) -- [paramsFromDDO](conditions.TransferNFT721Condition.md#paramsfromddo) -- [send](conditions.TransferNFT721Condition.md#send) -- [sendFrom](conditions.TransferNFT721Condition.md#sendfrom) -- [setInstanceConfig](conditions.TransferNFT721Condition.md#setinstanceconfig) -- [addressesStatic](conditions.TransferNFT721Condition.md#addressesstatic) -- [findSignerStatic](conditions.TransferNFT721Condition.md#findsignerstatic) -- [getInstance](conditions.TransferNFT721Condition.md#getinstance) -- [setInstanceConfig](conditions.TransferNFT721Condition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new TransferNFT721Condition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `nftReceiver`, `lockPaymentCondition`, `nftTokenAddress`, `willBeTransferred?`, `from?`, `txParams?`): `Promise`<`ContractReceipt`\> - -Fulfill the transfer NFT condition. - -**`Remarks`** - -Only DID owner or DID provider can call this method. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | The agreement identifier. | -| `did` | `string` | `undefined` | The DID of the asset with NFTs. | -| `nftReceiver` | `string` | `undefined` | The address of the account to receive the NFT. | -| `lockPaymentCondition` | `string` | `undefined` | lock payment condition identifier. | -| `nftTokenAddress` | `string` | `undefined` | address of the nft token to use. | -| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | -| `from?` | [`Account`](Account.md) | `undefined` | | -| `txParams?` | `TxParameters` | `undefined` | - | - -#### Returns - -`Promise`<`ContractReceipt`\> - -Condition state. - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L129) - -___ - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L154) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | `TransferNFT721ConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### params - -▸ **params**(`did`, `nftHolder`, `nftReceiver`, `lockCondition`, `nftTokenAddress`, `willBeTransferred?`, `expiration?`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Generates the hash of condition inputs. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `did` | `string` | `undefined` | The DID of the asset with NFTs. | -| `nftHolder` | `string` | `undefined` | The address of the Holder of the NFT. | -| `nftReceiver` | `string` | `undefined` | The address of the granted user or the DID provider. | -| `lockCondition` | `string` | `undefined` | Lock condition identifier. | -| `nftTokenAddress` | `string` | `undefined` | The address of the NFT token to use. | -| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | -| `expiration` | `number` | `0` | - | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Hash of all the values - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:43](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L43) - -___ - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`, `lockCondition`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `TransferNFT721ConditionContext` | -| `lockCondition` | `any` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:88](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L88) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`TransferNFT721Condition`](conditions.TransferNFT721Condition.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`TransferNFT721Condition`](conditions.TransferNFT721Condition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:22](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L22) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/conditions.TransferNFTCondition.md b/docs/nevermined-sdk/api-reference/classes/conditions.TransferNFTCondition.md deleted file mode 100644 index 4a8914060c..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/conditions.TransferNFTCondition.md +++ /dev/null @@ -1,1172 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / TransferNFTCondition - -# Class: TransferNFTCondition - -[conditions](../modules/conditions.md).TransferNFTCondition - -Condition allowing to transfer an NFT between the original owner and a receiver - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`TransferNFTConditionContext`\> - - ↳ **`TransferNFTCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.TransferNFTCondition.md#constructor) - -### Properties - -- [contract](conditions.TransferNFTCondition.md#contract) -- [contractName](conditions.TransferNFTCondition.md#contractname) -- [events](conditions.TransferNFTCondition.md#events) -- [version](conditions.TransferNFTCondition.md#version) - -### Accessors - -- [address](conditions.TransferNFTCondition.md#address) -- [artifactsFolder](conditions.TransferNFTCondition.md#artifactsfolder) -- [config](conditions.TransferNFTCondition.md#config) -- [instanceConfig](conditions.TransferNFTCondition.md#instanceconfig) -- [instantiableConfig](conditions.TransferNFTCondition.md#instantiableconfig) -- [logger](conditions.TransferNFTCondition.md#logger) -- [nevermined](conditions.TransferNFTCondition.md#nevermined) -- [web3](conditions.TransferNFTCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.TransferNFTCondition.md#abortbytimeout) -- [addresses](conditions.TransferNFTCondition.md#addresses) -- [call](conditions.TransferNFTCondition.md#call) -- [checkExists](conditions.TransferNFTCondition.md#checkexists) -- [findSigner](conditions.TransferNFTCondition.md#findsigner) -- [fulfill](conditions.TransferNFTCondition.md#fulfill) -- [fulfillForDelegate](conditions.TransferNFTCondition.md#fulfillfordelegate) -- [fulfillGateway](conditions.TransferNFTCondition.md#fulfillgateway) -- [fulfillInstance](conditions.TransferNFTCondition.md#fulfillinstance) -- [fulfillPlain](conditions.TransferNFTCondition.md#fulfillplain) -- [gatewayMethod](conditions.TransferNFTCondition.md#gatewaymethod) -- [generateId](conditions.TransferNFTCondition.md#generateid) -- [generateIdHash](conditions.TransferNFTCondition.md#generateidhash) -- [generateIdWithSeed](conditions.TransferNFTCondition.md#generateidwithseed) -- [getAddress](conditions.TransferNFTCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.TransferNFTCondition.md#getconditionfulfilledevent) -- [getContract](conditions.TransferNFTCondition.md#getcontract) -- [getFromAddress](conditions.TransferNFTCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.TransferNFTCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.TransferNFTCondition.md#getsignatureofmethod) -- [hashValues](conditions.TransferNFTCondition.md#hashvalues) -- [hashValuesPlain](conditions.TransferNFTCondition.md#hashvaluesplain) -- [init](conditions.TransferNFTCondition.md#init) -- [instance](conditions.TransferNFTCondition.md#instance) -- [instanceFromDDO](conditions.TransferNFTCondition.md#instancefromddo) -- [params](conditions.TransferNFTCondition.md#params) -- [paramsFromDDO](conditions.TransferNFTCondition.md#paramsfromddo) -- [send](conditions.TransferNFTCondition.md#send) -- [sendFrom](conditions.TransferNFTCondition.md#sendfrom) -- [setInstanceConfig](conditions.TransferNFTCondition.md#setinstanceconfig) -- [addressesStatic](conditions.TransferNFTCondition.md#addressesstatic) -- [findSignerStatic](conditions.TransferNFTCondition.md#findsignerstatic) -- [getInstance](conditions.TransferNFTCondition.md#getinstance) -- [setInstanceConfig](conditions.TransferNFTCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new TransferNFTCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `nftReceiver`, `nftAmount`, `lockPaymentCondition`, `from?`, `txParams?`): `Promise`<`ContractReceipt`\> - -Fulfill the transfer NFT condition. - -**`Remarks`** - -Only DID owner or DID provider can call this method. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | The agreement identifier. | -| `did` | `string` | The DID of the asset with NFTs. | -| `nftReceiver` | `string` | The address of the account to receive the NFT. | -| `nftAmount` | `default` | amount of NFTs to transfer. | -| `lockPaymentCondition` | `string` | lock payment condition identifier. | -| `from?` | [`Account`](Account.md) | | -| `txParams?` | `TxParameters` | - | - -#### Returns - -`Promise`<`ContractReceipt`\> - -Condition state. - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L124) - -___ - -### fulfillForDelegate - -▸ **fulfillForDelegate**(`agreementId`, `did`, `nftHolder`, `nftReceiver`, `nftAmount`, `lockPaymentCondition`, `transferAsset?`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -Fulfill the transfer NFT condition. - -**`Remarks`** - -Only DID owner or DID provider can call this method. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | The agreement identifier. | -| `did` | `string` | `undefined` | The DID of the asset with NFTs. | -| `nftHolder` | `string` | `undefined` | The address of the account currently holding the NFT. | -| `nftReceiver` | `string` | `undefined` | The address of the account to receive the NFT. | -| `nftAmount` | `default` | `undefined` | The amount of NFTs to transfer. | -| `lockPaymentCondition` | `string` | `undefined` | The lock payment condition identifier. | -| `transferAsset` | `boolean` | `true` | - | -| `from?` | [`Account`](Account.md) | `undefined` | | -| `params?` | `TxParameters` | `undefined` | - | - -#### Returns - -`Promise`<`ContractReceipt`\> - -Condition state. - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:156](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L156) - -___ - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - -___ - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - -___ - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - -___ - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L183) - -___ - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - -___ - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - -___ - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - -___ - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `ctx` | `TransferNFTConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - -___ - -### params - -▸ **params**(`did`, `nftHolder`, `nftReceiver`, `nftAmount`, `lockCondition`, `nftContractAddress?`, `willBeTransferred?`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Generates the hash of condition inputs. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `did` | `string` | `undefined` | The DID of the asset with NFTs. | -| `nftHolder` | `string` | `undefined` | The address of the holder of the NFT. | -| `nftReceiver` | `string` | `undefined` | The address of the granted user or the DID provider. | -| `nftAmount` | `default` | `undefined` | Amount of NFTs to transfer. | -| `lockCondition` | `string` | `undefined` | Lock condition identifier. | -| `nftContractAddress?` | `string` | `undefined` | The address of the NFT token to use. | -| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Hash of all the values - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:42](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L42) - -___ - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`, `lockCondition`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `TransferNFTConditionContext` | -| `lockCondition` | `any` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L90) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`TransferNFTCondition`](conditions.TransferNFTCondition.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`TransferNFTCondition`](conditions.TransferNFTCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L24) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/events.ContractEvent.md b/docs/nevermined-sdk/api-reference/classes/events.ContractEvent.md deleted file mode 100644 index 8d0d9b4ea3..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/events.ContractEvent.md +++ /dev/null @@ -1,585 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [events](../modules/events.md) / ContractEvent - -# Class: ContractEvent - -[events](../modules/events.md).ContractEvent - -## Hierarchy - -- [`NeverminedEvent`](events.NeverminedEvent.md) - - ↳ **`ContractEvent`** - -## Table of contents - -### Constructors - -- [constructor](events.ContractEvent.md#constructor) - -### Properties - -- [contract](events.ContractEvent.md#contract) -- [eventEmitter](events.ContractEvent.md#eventemitter) - -### Accessors - -- [artifactsFolder](events.ContractEvent.md#artifactsfolder) -- [config](events.ContractEvent.md#config) -- [instanceConfig](events.ContractEvent.md#instanceconfig) -- [instantiableConfig](events.ContractEvent.md#instantiableconfig) -- [logger](events.ContractEvent.md#logger) -- [nevermined](events.ContractEvent.md#nevermined) -- [web3](events.ContractEvent.md#web3) - -### Methods - -- [addresses](events.ContractEvent.md#addresses) -- [checkExists](events.ContractEvent.md#checkexists) -- [eventExists](events.ContractEvent.md#eventexists) -- [filterToArgs](events.ContractEvent.md#filtertoargs) -- [findSigner](events.ContractEvent.md#findsigner) -- [getBlockNumber](events.ContractEvent.md#getblocknumber) -- [getEventData](events.ContractEvent.md#geteventdata) -- [getPastEvents](events.ContractEvent.md#getpastevents) -- [once](events.ContractEvent.md#once) -- [setInstanceConfig](events.ContractEvent.md#setinstanceconfig) -- [subscribe](events.ContractEvent.md#subscribe) -- [addressesStatic](events.ContractEvent.md#addressesstatic) -- [findSignerStatic](events.ContractEvent.md#findsignerstatic) -- [getInstance](events.ContractEvent.md#getinstance) -- [setInstanceConfig](events.ContractEvent.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new ContractEvent**(`contract`, `eventEmitter`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contract` | `ContractBase` | -| `eventEmitter` | [`EventEmitter`](../interfaces/events.EventEmitter.md) | - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[constructor](events.NeverminedEvent.md#constructor) - -#### Defined in - -[src/events/NeverminedEvent.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L35) - -## Properties - -### contract - -• `Protected` **contract**: `ContractBase` = `null` - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[contract](events.NeverminedEvent.md#contract) - -#### Defined in - -[src/events/NeverminedEvent.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L30) - -___ - -### eventEmitter - -• `Protected` **eventEmitter**: [`EventEmitter`](../interfaces/events.EventEmitter.md) - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[eventEmitter](events.NeverminedEvent.md#eventemitter) - -#### Defined in - -[src/events/NeverminedEvent.ts:29](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L29) - -## Accessors - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -NeverminedEvent.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -NeverminedEvent.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -NeverminedEvent.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -NeverminedEvent.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -NeverminedEvent.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -NeverminedEvent.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -NeverminedEvent.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[addresses](events.NeverminedEvent.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[checkExists](events.NeverminedEvent.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### eventExists - -▸ `Private` **eventExists**(`eventName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/events/ContractEvent.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/ContractEvent.ts#L69) - -___ - -### filterToArgs - -▸ `Private` **filterToArgs**(`eventName`, `filter`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` | -| `filter` | [`Filter`](../interfaces/events.Filter.md) | - -#### Returns - -`any`[] - -#### Defined in - -[src/events/ContractEvent.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/ContractEvent.ts#L73) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[findSigner](events.NeverminedEvent.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### getBlockNumber - -▸ **getBlockNumber**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Overrides - -[NeverminedEvent](events.NeverminedEvent.md).[getBlockNumber](events.NeverminedEvent.md#getblocknumber) - -#### Defined in - -[src/events/ContractEvent.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/ContractEvent.ts#L65) - -___ - -### getEventData - -▸ **getEventData**(`options`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Overrides - -[NeverminedEvent](events.NeverminedEvent.md).[getEventData](events.NeverminedEvent.md#geteventdata) - -#### Defined in - -[src/events/ContractEvent.ts:29](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/ContractEvent.ts#L29) - -___ - -### getPastEvents - -▸ **getPastEvents**(`options`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Overrides - -[NeverminedEvent](events.NeverminedEvent.md).[getPastEvents](events.NeverminedEvent.md#getpastevents) - -#### Defined in - -[src/events/ContractEvent.ts:47](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/ContractEvent.ts#L47) - -___ - -### once - -▸ **once**(`callback?`, `options?`): `Promise`<[`EventResult`](../modules/events.md#eventresult)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback?` | (`events`: [`EventResult`](../modules/events.md#eventresult)[]) => `void` | -| `options?` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -`Promise`<[`EventResult`](../modules/events.md#eventresult)\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[once](events.NeverminedEvent.md#once) - -#### Defined in - -[src/events/NeverminedEvent.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L55) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[setInstanceConfig](events.NeverminedEvent.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### subscribe - -▸ **subscribe**(`callback`, `options`): [`ContractEventSubscription`](../interfaces/events.ContractEventSubscription.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | (`events`: [`EventResult`](../modules/events.md#eventresult)[]) => `void` | -| `options` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -[`ContractEventSubscription`](../interfaces/events.ContractEventSubscription.md) - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[subscribe](events.NeverminedEvent.md#subscribe) - -#### Defined in - -[src/events/NeverminedEvent.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L41) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[addressesStatic](events.NeverminedEvent.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[findSignerStatic](events.NeverminedEvent.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`contract`, `eventEmitter`, `nevermined`, `web3`): [`ContractEvent`](events.ContractEvent.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contract` | `ContractBase` | -| `eventEmitter` | [`EventEmitter`](../interfaces/events.EventEmitter.md) | -| `nevermined` | [`Nevermined`](Nevermined.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -[`ContractEvent`](events.ContractEvent.md) - -#### Overrides - -[NeverminedEvent](events.NeverminedEvent.md).[getInstance](events.NeverminedEvent.md#getinstance) - -#### Defined in - -[src/events/ContractEvent.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/ContractEvent.ts#L14) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[setInstanceConfig](events.NeverminedEvent.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/events.EventHandler.md b/docs/nevermined-sdk/api-reference/classes/events.EventHandler.md deleted file mode 100644 index 516fcf8576..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/events.EventHandler.md +++ /dev/null @@ -1,184 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [events](../modules/events.md) / EventHandler - -# Class: EventHandler - -[events](../modules/events.md).EventHandler - -## Table of contents - -### Constructors - -- [constructor](events.EventHandler.md#constructor) - -### Properties - -- [events](events.EventHandler.md#events) -- [getBlockNumber](events.EventHandler.md#getblocknumber) -- [interval](events.EventHandler.md#interval) -- [lastBlock](events.EventHandler.md#lastblock) -- [lastTimeout](events.EventHandler.md#lasttimeout) -- [polling](events.EventHandler.md#polling) - -### Accessors - -- [count](events.EventHandler.md#count) - -### Methods - -- [checkBlock](events.EventHandler.md#checkblock) -- [subscribe](events.EventHandler.md#subscribe) -- [unsubscribe](events.EventHandler.md#unsubscribe) - -## Constructors - -### constructor - -• **new EventHandler**() - -## Properties - -### events - -• `Private` **events**: `Set`<(`blockNumber`: `any`) => `void`\> - -#### Defined in - -[src/events/EventHandler.ts:6](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L6) - -___ - -### getBlockNumber - -• `Private` **getBlockNumber**: () => `Promise`<`number`\> - -#### Type declaration - -▸ (): `Promise`<`number`\> - -##### Returns - -`Promise`<`number`\> - -#### Defined in - -[src/events/EventHandler.ts:16](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L16) - -___ - -### interval - -• `Private` **interval**: `number` = `200` - -#### Defined in - -[src/events/EventHandler.ts:10](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L10) - -___ - -### lastBlock - -• `Private` **lastBlock**: `number` - -#### Defined in - -[src/events/EventHandler.ts:8](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L8) - -___ - -### lastTimeout - -• `Private` **lastTimeout**: `Timeout` - -#### Defined in - -[src/events/EventHandler.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L14) - -___ - -### polling - -• `Private` **polling**: `boolean` = `false` - -#### Defined in - -[src/events/EventHandler.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L12) - -## Accessors - -### count - -• `get` **count**(): `number` - -#### Returns - -`number` - -#### Defined in - -[src/events/EventHandler.ts:2](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L2) - -## Methods - -### checkBlock - -▸ `Private` **checkBlock**(`isInterval?`, `n?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `isInterval?` | `boolean` | `undefined` | -| `n` | `number` | `0` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[src/events/EventHandler.ts:40](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L40) - -___ - -### subscribe - -▸ **subscribe**(`callback`, `getBlockNumber`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | (`blockNumber`: `number`) => `void` | -| `getBlockNumber` | () => `Promise`<`number`\> | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `unsubscribe` | () => `void` | - -#### Defined in - -[src/events/EventHandler.ts:18](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L18) - -___ - -### unsubscribe - -▸ **unsubscribe**(`callback`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | (`blockNumber`: `number`) => `void` | - -#### Returns - -`void` - -#### Defined in - -[src/events/EventHandler.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L31) diff --git a/docs/nevermined-sdk/api-reference/classes/events.NeverminedEvent.md b/docs/nevermined-sdk/api-reference/classes/events.NeverminedEvent.md deleted file mode 100644 index ab83e60d6e..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/events.NeverminedEvent.md +++ /dev/null @@ -1,521 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [events](../modules/events.md) / NeverminedEvent - -# Class: NeverminedEvent - -[events](../modules/events.md).NeverminedEvent - -## Hierarchy - -- `Instantiable` - - ↳ **`NeverminedEvent`** - - ↳↳ [`ContractEvent`](events.ContractEvent.md) - - ↳↳ [`SubgraphEvent`](events.SubgraphEvent.md) - -## Table of contents - -### Constructors - -- [constructor](events.NeverminedEvent.md#constructor) - -### Properties - -- [contract](events.NeverminedEvent.md#contract) -- [eventEmitter](events.NeverminedEvent.md#eventemitter) - -### Accessors - -- [artifactsFolder](events.NeverminedEvent.md#artifactsfolder) -- [config](events.NeverminedEvent.md#config) -- [instanceConfig](events.NeverminedEvent.md#instanceconfig) -- [instantiableConfig](events.NeverminedEvent.md#instantiableconfig) -- [logger](events.NeverminedEvent.md#logger) -- [nevermined](events.NeverminedEvent.md#nevermined) -- [web3](events.NeverminedEvent.md#web3) - -### Methods - -- [addresses](events.NeverminedEvent.md#addresses) -- [checkExists](events.NeverminedEvent.md#checkexists) -- [findSigner](events.NeverminedEvent.md#findsigner) -- [getBlockNumber](events.NeverminedEvent.md#getblocknumber) -- [getEventData](events.NeverminedEvent.md#geteventdata) -- [getPastEvents](events.NeverminedEvent.md#getpastevents) -- [once](events.NeverminedEvent.md#once) -- [setInstanceConfig](events.NeverminedEvent.md#setinstanceconfig) -- [subscribe](events.NeverminedEvent.md#subscribe) -- [addressesStatic](events.NeverminedEvent.md#addressesstatic) -- [findSignerStatic](events.NeverminedEvent.md#findsignerstatic) -- [getInstance](events.NeverminedEvent.md#getinstance) -- [setInstanceConfig](events.NeverminedEvent.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new NeverminedEvent**(`contract`, `eventEmitter`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contract` | `ContractBase` | -| `eventEmitter` | [`EventEmitter`](../interfaces/events.EventEmitter.md) | - -#### Overrides - -Instantiable.constructor - -#### Defined in - -[src/events/NeverminedEvent.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L35) - -## Properties - -### contract - -• `Protected` **contract**: `ContractBase` = `null` - -#### Defined in - -[src/events/NeverminedEvent.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L30) - -___ - -### eventEmitter - -• `Protected` **eventEmitter**: [`EventEmitter`](../interfaces/events.EventEmitter.md) - -#### Defined in - -[src/events/NeverminedEvent.ts:29](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L29) - -## Accessors - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -Instantiable.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -Instantiable.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Instantiable.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Instantiable.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -Instantiable.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -Instantiable.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -Instantiable.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addresses - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -Instantiable.checkExists - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSigner - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### getBlockNumber - -▸ `Abstract` **getBlockNumber**(...`args`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -[src/events/NeverminedEvent.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L33) - -___ - -### getEventData - -▸ `Abstract` **getEventData**(`options`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Defined in - -[src/events/NeverminedEvent.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L31) - -___ - -### getPastEvents - -▸ `Abstract` **getPastEvents**(`options`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Defined in - -[src/events/NeverminedEvent.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L32) - -___ - -### once - -▸ **once**(`callback?`, `options?`): `Promise`<[`EventResult`](../modules/events.md#eventresult)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback?` | (`events`: [`EventResult`](../modules/events.md#eventresult)[]) => `void` | -| `options?` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -`Promise`<[`EventResult`](../modules/events.md#eventresult)\> - -#### Defined in - -[src/events/NeverminedEvent.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L55) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -Instantiable.setInstanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### subscribe - -▸ **subscribe**(`callback`, `options`): [`ContractEventSubscription`](../interfaces/events.ContractEventSubscription.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | (`events`: [`EventResult`](../modules/events.md#eventresult)[]) => `void` | -| `options` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -[`ContractEventSubscription`](../interfaces/events.ContractEventSubscription.md) - -#### Defined in - -[src/events/NeverminedEvent.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L41) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addressesStatic - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSignerStatic - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(...`_args`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `..._args` | `any` | - -#### Returns - -`any` - -#### Inherited from - -Instantiable.getInstance - -#### Defined in - -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L158) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -Instantiable.setInstanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/events.SubgraphEvent.md b/docs/nevermined-sdk/api-reference/classes/events.SubgraphEvent.md deleted file mode 100644 index d079f2e687..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/events.SubgraphEvent.md +++ /dev/null @@ -1,590 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [events](../modules/events.md) / SubgraphEvent - -# Class: SubgraphEvent - -[events](../modules/events.md).SubgraphEvent - -## Hierarchy - -- [`NeverminedEvent`](events.NeverminedEvent.md) - - ↳ **`SubgraphEvent`** - -## Table of contents - -### Constructors - -- [constructor](events.SubgraphEvent.md#constructor) - -### Properties - -- [contract](events.SubgraphEvent.md#contract) -- [eventEmitter](events.SubgraphEvent.md#eventemitter) -- [graphHttpUri](events.SubgraphEvent.md#graphhttpuri) -- [networkName](events.SubgraphEvent.md#networkname) -- [subgraph](events.SubgraphEvent.md#subgraph) - -### Accessors - -- [artifactsFolder](events.SubgraphEvent.md#artifactsfolder) -- [config](events.SubgraphEvent.md#config) -- [instanceConfig](events.SubgraphEvent.md#instanceconfig) -- [instantiableConfig](events.SubgraphEvent.md#instantiableconfig) -- [logger](events.SubgraphEvent.md#logger) -- [nevermined](events.SubgraphEvent.md#nevermined) -- [web3](events.SubgraphEvent.md#web3) - -### Methods - -- [addresses](events.SubgraphEvent.md#addresses) -- [checkExists](events.SubgraphEvent.md#checkexists) -- [findSigner](events.SubgraphEvent.md#findsigner) -- [getBlockNumber](events.SubgraphEvent.md#getblocknumber) -- [getEventData](events.SubgraphEvent.md#geteventdata) -- [getPastEvents](events.SubgraphEvent.md#getpastevents) -- [once](events.SubgraphEvent.md#once) -- [setInstanceConfig](events.SubgraphEvent.md#setinstanceconfig) -- [subgraphUrl](events.SubgraphEvent.md#subgraphurl) -- [subscribe](events.SubgraphEvent.md#subscribe) -- [addressesStatic](events.SubgraphEvent.md#addressesstatic) -- [findSignerStatic](events.SubgraphEvent.md#findsignerstatic) -- [getInstance](events.SubgraphEvent.md#getinstance) -- [setInstanceConfig](events.SubgraphEvent.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new SubgraphEvent**(`contract`, `eventEmitter`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contract` | `ContractBase` | -| `eventEmitter` | [`EventEmitter`](../interfaces/events.EventEmitter.md) | - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[constructor](events.NeverminedEvent.md#constructor) - -#### Defined in - -[src/events/NeverminedEvent.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L35) - -## Properties - -### contract - -• `Protected` **contract**: `ContractBase` = `null` - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[contract](events.NeverminedEvent.md#contract) - -#### Defined in - -[src/events/NeverminedEvent.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L30) - -___ - -### eventEmitter - -• `Protected` **eventEmitter**: [`EventEmitter`](../interfaces/events.EventEmitter.md) - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[eventEmitter](events.NeverminedEvent.md#eventemitter) - -#### Defined in - -[src/events/NeverminedEvent.ts:29](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L29) - -___ - -### graphHttpUri - -• `Private` **graphHttpUri**: `string` - -#### Defined in - -[src/events/SubgraphEvent.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/SubgraphEvent.ts#L14) - -___ - -### networkName - -• `Private` **networkName**: `string` - -#### Defined in - -[src/events/SubgraphEvent.ts:16](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/SubgraphEvent.ts#L16) - -___ - -### subgraph - -• **subgraph**: `any` - -#### Defined in - -[src/events/SubgraphEvent.ts:15](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/SubgraphEvent.ts#L15) - -## Accessors - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -NeverminedEvent.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -NeverminedEvent.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -NeverminedEvent.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -NeverminedEvent.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -NeverminedEvent.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -NeverminedEvent.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -NeverminedEvent.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[addresses](events.NeverminedEvent.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[checkExists](events.NeverminedEvent.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[findSigner](events.NeverminedEvent.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### getBlockNumber - -▸ **getBlockNumber**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Overrides - -[NeverminedEvent](events.NeverminedEvent.md).[getBlockNumber](events.NeverminedEvent.md#getblocknumber) - -#### Defined in - -[src/events/SubgraphEvent.ts:56](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/SubgraphEvent.ts#L56) - -___ - -### getEventData - -▸ **getEventData**(`options`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Overrides - -[NeverminedEvent](events.NeverminedEvent.md).[getEventData](events.NeverminedEvent.md#geteventdata) - -#### Defined in - -[src/events/SubgraphEvent.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/SubgraphEvent.ts#L31) - -___ - -### getPastEvents - -▸ **getPastEvents**(`options`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Overrides - -[NeverminedEvent](events.NeverminedEvent.md).[getPastEvents](events.NeverminedEvent.md#getpastevents) - -#### Defined in - -[src/events/SubgraphEvent.ts:52](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/SubgraphEvent.ts#L52) - -___ - -### once - -▸ **once**(`callback?`, `options?`): `Promise`<[`EventResult`](../modules/events.md#eventresult)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback?` | (`events`: [`EventResult`](../modules/events.md#eventresult)[]) => `void` | -| `options?` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -`Promise`<[`EventResult`](../modules/events.md#eventresult)\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[once](events.NeverminedEvent.md#once) - -#### Defined in - -[src/events/NeverminedEvent.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L55) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[setInstanceConfig](events.NeverminedEvent.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### subgraphUrl - -▸ `Private` **subgraphUrl**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/events/SubgraphEvent.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/SubgraphEvent.ts#L63) - -___ - -### subscribe - -▸ **subscribe**(`callback`, `options`): [`ContractEventSubscription`](../interfaces/events.ContractEventSubscription.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | (`events`: [`EventResult`](../modules/events.md#eventresult)[]) => `void` | -| `options` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -[`ContractEventSubscription`](../interfaces/events.ContractEventSubscription.md) - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[subscribe](events.NeverminedEvent.md#subscribe) - -#### Defined in - -[src/events/NeverminedEvent.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L41) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[addressesStatic](events.NeverminedEvent.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[findSignerStatic](events.NeverminedEvent.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`contract`, `eventEmitter`, `graphHttpUri`, `networkName`): [`SubgraphEvent`](events.SubgraphEvent.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contract` | `ContractBase` | -| `eventEmitter` | [`EventEmitter`](../interfaces/events.EventEmitter.md) | -| `graphHttpUri` | `string` | -| `networkName` | `string` | - -#### Returns - -[`SubgraphEvent`](events.SubgraphEvent.md) - -#### Overrides - -[NeverminedEvent](events.NeverminedEvent.md).[getInstance](events.NeverminedEvent.md#getinstance) - -#### Defined in - -[src/events/SubgraphEvent.ts:17](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/SubgraphEvent.ts#L17) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[setInstanceConfig](events.NeverminedEvent.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/templates.AaveCreditTemplate.md b/docs/nevermined-sdk/api-reference/classes/templates.AaveCreditTemplate.md deleted file mode 100644 index fead20b7b2..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/templates.AaveCreditTemplate.md +++ /dev/null @@ -1,1723 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [templates](../modules/templates.md) / AaveCreditTemplate - -# Class: AaveCreditTemplate - -[templates](../modules/templates.md).AaveCreditTemplate - -## Hierarchy - -- [`BaseTemplate`](templates.BaseTemplate.md)<`AaveCreditTemplateParams`, `ServiceAaveCredit`\> - - ↳ **`AaveCreditTemplate`** - -## Table of contents - -### Constructors - -- [constructor](templates.AaveCreditTemplate.md#constructor) - -### Properties - -- [aaveConfig](templates.AaveCreditTemplate.md#aaveconfig) -- [contract](templates.AaveCreditTemplate.md#contract) -- [contractName](templates.AaveCreditTemplate.md#contractname) -- [events](templates.AaveCreditTemplate.md#events) -- [version](templates.AaveCreditTemplate.md#version) - -### Accessors - -- [address](templates.AaveCreditTemplate.md#address) -- [artifactsFolder](templates.AaveCreditTemplate.md#artifactsfolder) -- [config](templates.AaveCreditTemplate.md#config) -- [instanceConfig](templates.AaveCreditTemplate.md#instanceconfig) -- [instantiableConfig](templates.AaveCreditTemplate.md#instantiableconfig) -- [logger](templates.AaveCreditTemplate.md#logger) -- [nevermined](templates.AaveCreditTemplate.md#nevermined) -- [web3](templates.AaveCreditTemplate.md#web3) - -### Methods - -- [\_createAgreement](templates.AaveCreditTemplate.md#_createagreement) -- [accept](templates.AaveCreditTemplate.md#accept) -- [addresses](templates.AaveCreditTemplate.md#addresses) -- [agreementId](templates.AaveCreditTemplate.md#agreementid) -- [call](templates.AaveCreditTemplate.md#call) -- [checkExists](templates.AaveCreditTemplate.md#checkexists) -- [conditions](templates.AaveCreditTemplate.md#conditions) -- [createAgreement](templates.AaveCreditTemplate.md#createagreement) -- [createAgreementAndDeployVault](templates.AaveCreditTemplate.md#createagreementanddeployvault) -- [createAgreementAndPay](templates.AaveCreditTemplate.md#createagreementandpay) -- [createAgreementFromDDO](templates.AaveCreditTemplate.md#createagreementfromddo) -- [createAgreementWithPaymentFromDDO](templates.AaveCreditTemplate.md#createagreementwithpaymentfromddo) -- [createService](templates.AaveCreditTemplate.md#createservice) -- [deployVault](templates.AaveCreditTemplate.md#deployvault) -- [description](templates.AaveCreditTemplate.md#description) -- [extraGen](templates.AaveCreditTemplate.md#extragen) -- [findSigner](templates.AaveCreditTemplate.md#findsigner) -- [getAddress](templates.AaveCreditTemplate.md#getaddress) -- [getAgreementCreatedEvent](templates.AaveCreditTemplate.md#getagreementcreatedevent) -- [getAgreementData](templates.AaveCreditTemplate.md#getagreementdata) -- [getAgreementDid](templates.AaveCreditTemplate.md#getagreementdid) -- [getAgreementIdsFromDDO](templates.AaveCreditTemplate.md#getagreementidsfromddo) -- [getAgreementStatus](templates.AaveCreditTemplate.md#getagreementstatus) -- [getAgreementVaultAddress](templates.AaveCreditTemplate.md#getagreementvaultaddress) -- [getAgreementsForDID](templates.AaveCreditTemplate.md#getagreementsfordid) -- [getConditionTypes](templates.AaveCreditTemplate.md#getconditiontypes) -- [getConditions](templates.AaveCreditTemplate.md#getconditions) -- [getContract](templates.AaveCreditTemplate.md#getcontract) -- [getFromAddress](templates.AaveCreditTemplate.md#getfromaddress) -- [getInputsOfMethod](templates.AaveCreditTemplate.md#getinputsofmethod) -- [getServiceAgreementTemplate](templates.AaveCreditTemplate.md#getserviceagreementtemplate) -- [getServiceAgreementTemplateConditionByRef](templates.AaveCreditTemplate.md#getserviceagreementtemplateconditionbyref) -- [getServiceAgreementTemplateConditions](templates.AaveCreditTemplate.md#getserviceagreementtemplateconditions) -- [getServiceAgreementTemplateDependencies](templates.AaveCreditTemplate.md#getserviceagreementtemplatedependencies) -- [getSignatureOfMethod](templates.AaveCreditTemplate.md#getsignatureofmethod) -- [init](templates.AaveCreditTemplate.md#init) -- [instanceFromDDO](templates.AaveCreditTemplate.md#instancefromddo) -- [lockConditionIndex](templates.AaveCreditTemplate.md#lockconditionindex) -- [lockTokens](templates.AaveCreditTemplate.md#locktokens) -- [name](templates.AaveCreditTemplate.md#name) -- [params](templates.AaveCreditTemplate.md#params) -- [paramsGen](templates.AaveCreditTemplate.md#paramsgen) -- [paymentData](templates.AaveCreditTemplate.md#paymentdata) -- [printAgreementStatus](templates.AaveCreditTemplate.md#printagreementstatus) -- [process](templates.AaveCreditTemplate.md#process) -- [send](templates.AaveCreditTemplate.md#send) -- [sendFrom](templates.AaveCreditTemplate.md#sendfrom) -- [service](templates.AaveCreditTemplate.md#service) -- [serviceEndpoint](templates.AaveCreditTemplate.md#serviceendpoint) -- [setInstanceConfig](templates.AaveCreditTemplate.md#setinstanceconfig) -- [standardContext](templates.AaveCreditTemplate.md#standardcontext) -- [validateAgreement](templates.AaveCreditTemplate.md#validateagreement) -- [addressesStatic](templates.AaveCreditTemplate.md#addressesstatic) -- [findSignerStatic](templates.AaveCreditTemplate.md#findsignerstatic) -- [getInstance](templates.AaveCreditTemplate.md#getinstance) -- [setInstanceConfig](templates.AaveCreditTemplate.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new AaveCreditTemplate**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[constructor](templates.BaseTemplate.md#constructor) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L75) - -## Properties - -### aaveConfig - -• **aaveConfig**: `AaveConfig` - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:52](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L52) - -___ - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contract](templates.BaseTemplate.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contractName](templates.BaseTemplate.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[events](templates.BaseTemplate.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[version](templates.BaseTemplate.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -BaseTemplate.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -BaseTemplate.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -BaseTemplate.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -BaseTemplate.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### \_createAgreement - -▸ `Private` **_createAgreement**(`agreementIdSeed`, `ddo`, `vaultAddress`, `nftTokenContract`, `nftAmount`, `collateralToken`, `collateralAmount`, `delegatedToken`, `delegatedAmount`, `interestRateMode`, `timeLocks`, `timeOuts`, `txParams?`, `from?`): `Promise`<[`ContractReceipt`, [`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`AaveCreditTemplateParams`\>]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `vaultAddress` | `string` | -| `nftTokenContract` | `string` | -| `nftAmount` | `number` | -| `collateralToken` | `string` | -| `collateralAmount` | `number` | -| `delegatedToken` | `string` | -| `delegatedAmount` | `number` | -| `interestRateMode` | `number` | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `txParams?` | `TxParameters` | -| `from?` | [`Account`](Account.md) | - -#### Returns - -`Promise`<[`ContractReceipt`, [`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`AaveCreditTemplateParams`\>]\> - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:102](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L102) - -___ - -### accept - -▸ **accept**(`_params`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[accept](templates.BaseTemplate.md#accept) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:112](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L112) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addresses](templates.BaseTemplate.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### agreementId - -▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `creator` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[agreementId](templates.BaseTemplate.md#agreementid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[call](templates.BaseTemplate.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[checkExists](templates.BaseTemplate.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### conditions - -▸ **conditions**(): [[`NFT721LockCondition`](conditions.NFT721LockCondition.md), [`AaveCollateralDepositCondition`](conditions.AaveCollateralDepositCondition.md), [`AaveBorrowCondition`](conditions.AaveBorrowCondition.md), [`AaveRepayCondition`](conditions.AaveRepayCondition.md), [`AaveCollateralWithdrawCondition`](conditions.AaveCollateralWithdrawCondition.md), [`DistributeNFTCollateralCondition`](conditions.DistributeNFTCollateralCondition.md)] - -#### Returns - -[[`NFT721LockCondition`](conditions.NFT721LockCondition.md), [`AaveCollateralDepositCondition`](conditions.AaveCollateralDepositCondition.md), [`AaveBorrowCondition`](conditions.AaveBorrowCondition.md), [`AaveRepayCondition`](conditions.AaveRepayCondition.md), [`AaveCollateralWithdrawCondition`](conditions.AaveCollateralWithdrawCondition.md), [`DistributeNFTCollateralCondition`](conditions.DistributeNFTCollateralCondition.md)] - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[conditions](templates.BaseTemplate.md#conditions) - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:285](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L285) - -___ - -### createAgreement - -▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `extraArgs` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreement](templates.BaseTemplate.md#createagreement) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L99) - -___ - -### createAgreementAndDeployVault - -▸ **createAgreementAndDeployVault**(`agreementIdSeed`, `ddo`, `nftTokenContract`, `nftAmount`, `collateralToken`, `collateralAmount`, `delegatedToken`, `delegatedAmount`, `interestRateMode`, `borrower`, `lender`, `timeLocks`, `timeOuts`, `txParams?`, `from?`): `Promise`<[`ContractReceipt`, `string`, [`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`AaveCreditTemplateParams`\>]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `nftTokenContract` | `string` | -| `nftAmount` | `number` | -| `collateralToken` | `string` | -| `collateralAmount` | `number` | -| `delegatedToken` | `string` | -| `delegatedAmount` | `number` | -| `interestRateMode` | `number` | -| `borrower` | `string` | -| `lender` | `string` | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `txParams?` | `TxParameters` | -| `from?` | [`Account`](Account.md) | - -#### Returns - -`Promise`<[`ContractReceipt`, `string`, [`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`AaveCreditTemplateParams`\>]\> - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:155](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L155) - -___ - -### createAgreementAndPay - -▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `accessConsumer` | `string` | -| `condIdx` | `number` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `default`[] | -| `receivers` | `string`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementAndPay](templates.BaseTemplate.md#createagreementandpay) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L124) - -___ - -### createAgreementFromDDO - -▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `params?`): `Promise`<`string`\> - -Create a new agreement using the data of a DDO. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementIdSeed` | `string` | - | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `parameters` | `AaveCreditTemplateParams` | | -| `consumer` | [`Account`](Account.md) | - | -| `from` | [`Account`](Account.md) | - | -| `timeOuts?` | `number`[] | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`string`\> - -true if the call was successful. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementFromDDO](templates.BaseTemplate.md#createagreementfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L225) - -___ - -### createAgreementWithPaymentFromDDO - -▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`, `observer?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `parameters` | `AaveCreditTemplateParams` | -| `consumer` | [`Account`](Account.md) | -| `from` | [`Account`](Account.md) | -| `timeOuts?` | `number`[] | -| `txParams?` | `TxParameters` | -| `observer?` | (`OrderProgressStep`: `any`) => `void` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementWithPaymentFromDDO](templates.BaseTemplate.md#createagreementwithpaymentfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L255) - -___ - -### createService - -▸ **createService**(`publisher`, `metadata`, `assetRewards?`, `erc20TokenAddress?`, `priced?`): `Promise`<`ServiceAaveCredit`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `publisher` | [`Account`](Account.md) | `undefined` | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | -| `assetRewards?` | `default` | `undefined` | -| `erc20TokenAddress?` | `string` | `undefined` | -| `priced` | `boolean` | `false` | - -#### Returns - -`Promise`<`ServiceAaveCredit`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createService](templates.BaseTemplate.md#createservice) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L65) - -___ - -### deployVault - -▸ **deployVault**(`lendingPool`, `dataProvider`, `weth`, `agreementFee`, `treasuryAddress`, `borrower`, `lender`, `from`): `Promise`<`string`\> - -Deploy a new credit vault that is required to facilitate an Aave credit agreement - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `lendingPool` | `string` | -| `dataProvider` | `string` | -| `weth` | `string` | -| `agreementFee` | `number` | -| `treasuryAddress` | `string` | -| `borrower` | `string` | -| `lender` | `string` | -| `from` | `string` | - -#### Returns - -`Promise`<`string`\> - -Agreement ID. - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L207) - -___ - -### description - -▸ **description**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[description](templates.BaseTemplate.md#description) - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:49](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L49) - -___ - -### extraGen - -▸ **extraGen**(`_params`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[extraGen](templates.BaseTemplate.md#extragen) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSigner](templates.BaseTemplate.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAddress](templates.BaseTemplate.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getAgreementCreatedEvent - -▸ **getAgreementCreatedEvent**(`agreementId`): `Promise`<`any`[]\> - -Generates and returns the agreement creation event. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`any`[]\> - -Agreement created event. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementCreatedEvent](templates.BaseTemplate.md#getagreementcreatedevent) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L469) - -___ - -### getAgreementData - -▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementData](templates.BaseTemplate.md#getagreementdata) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) - -___ - -### getAgreementDid - -▸ **getAgreementDid**(`agreementId`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:318](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L318) - -___ - -### getAgreementIdsFromDDO - -▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> - -Get agreement conditions IDs. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `AaveCreditTemplateParams` | - | - -#### Returns - -`Promise`<`string`[]\> - -The condition IDs. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementIdsFromDDO](templates.BaseTemplate.md#getagreementidsfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L183) - -___ - -### getAgreementStatus - -▸ **getAgreementStatus**(`agreementId`): `Promise`<``false`` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -Returns the status of the conditions. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<``false`` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -The conditions status. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementStatus](templates.BaseTemplate.md#getagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L343) - -___ - -### getAgreementVaultAddress - -▸ **getAgreementVaultAddress**(`agreementId`, `from`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `from` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:311](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L311) - -___ - -### getAgreementsForDID - -▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementsForDID](templates.BaseTemplate.md#getagreementsfordid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L496) - -___ - -### getConditionTypes - -▸ **getConditionTypes**(): `Promise`<`string`[]\> - -Conditions address list. - -#### Returns - -`Promise`<`string`[]\> - -A list of condition addresses. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditionTypes](templates.BaseTemplate.md#getconditiontypes) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L163) - -___ - -### getConditions - -▸ **getConditions**(): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -List of condition contracts. - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -A list of condition contracts. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditions](templates.BaseTemplate.md#getconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L171) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getContract](templates.BaseTemplate.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getFromAddress](templates.BaseTemplate.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getInputsOfMethod](templates.BaseTemplate.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getServiceAgreementTemplate - -▸ **getServiceAgreementTemplate**(): `Promise`<`ServiceAgreementTemplate`\> - -#### Returns - -`Promise`<`ServiceAgreementTemplate`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplate](templates.BaseTemplate.md#getserviceagreementtemplate) - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:98](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L98) - -___ - -### getServiceAgreementTemplateConditionByRef - -▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ref` | `string` | - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](templates.BaseTemplate.md#getserviceagreementtemplateconditionbyref) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) - -___ - -### getServiceAgreementTemplateConditions - -▸ **getServiceAgreementTemplateConditions**(): `Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Returns - -`Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditions](templates.BaseTemplate.md#getserviceagreementtemplateconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L319) - -___ - -### getServiceAgreementTemplateDependencies - -▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Returns - -`Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateDependencies](templates.BaseTemplate.md#getserviceagreementtemplatedependencies) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L333) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getSignatureOfMethod](templates.BaseTemplate.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[init](templates.BaseTemplate.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`AaveCreditTemplateParams`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `AaveCreditTemplateParams` | - -#### Returns - -`Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`AaveCreditTemplateParams`\>\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[instanceFromDDO](templates.BaseTemplate.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:233](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L233) - -___ - -### lockConditionIndex - -▸ **lockConditionIndex**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockConditionIndex](templates.BaseTemplate.md#lockconditionindex) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L81) - -___ - -### lockTokens - -▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`Account`](Account.md) | -| `txParams` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockTokens](templates.BaseTemplate.md#locktokens) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L398) - -___ - -### name - -▸ **name**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[name](templates.BaseTemplate.md#name) - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:46](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L46) - -___ - -### params - -▸ **params**(`vaultAddress`, `nftContractAddress`, `nftAmount`, `collateralAsset`, `collateralAmount`, `delegatedAsset`, `delegatedAmount`, `interestRateMode`): `AaveCreditTemplateParams` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `vaultAddress` | `string` | -| `nftContractAddress` | `string` | -| `nftAmount` | `number` | -| `collateralAsset` | `string` | -| `collateralAmount` | `string` | -| `delegatedAsset` | `string` | -| `delegatedAmount` | `string` | -| `interestRateMode` | `number` | - -#### Returns - -`AaveCreditTemplateParams` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[params](templates.BaseTemplate.md#params) - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:71](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L71) - -___ - -### paramsGen - -▸ **paramsGen**(`_params`): `Promise`<`AaveCreditTemplateParams`\> - -Specialize params - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_params` | `ValidationParams` | Generic parameters | - -#### Returns - -`Promise`<`AaveCreditTemplateParams`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[paramsGen](templates.BaseTemplate.md#paramsgen) - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:43](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L43) - -___ - -### paymentData - -▸ **paymentData**(`service`): [`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `service` | `ServiceCommon` | - -#### Returns - -[`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[paymentData](templates.BaseTemplate.md#paymentdata) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L85) - -___ - -### printAgreementStatus - -▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> - -Prints the agreement status. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[printAgreementStatus](templates.BaseTemplate.md#printagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L439) - -___ - -### process - -▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `ValidationParams` | -| `from` | [`Account`](Account.md) | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[process](templates.BaseTemplate.md#process) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L116) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[send](templates.BaseTemplate.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[sendFrom](templates.BaseTemplate.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### service - -▸ **service**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[service](templates.BaseTemplate.md#service) - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:67](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L67) - -___ - -### serviceEndpoint - -▸ **serviceEndpoint**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[serviceEndpoint](templates.BaseTemplate.md#serviceendpoint) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### standardContext - -▸ **standardContext**(`ddo`, `creator`): [`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | - -#### Returns - -[`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[standardContext](templates.BaseTemplate.md#standardcontext) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L207) - -___ - -### validateAgreement - -▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `AaveCreditTemplateParams` | -| `from` | [`Account`](Account.md) | -| `extra` | `any` | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[validateAgreement](templates.BaseTemplate.md#validateagreement) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L131) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addressesStatic](templates.BaseTemplate.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSignerStatic](templates.BaseTemplate.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`AaveCreditTemplate`](templates.AaveCreditTemplate.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`AaveCreditTemplate`](templates.AaveCreditTemplate.md)\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getInstance](templates.BaseTemplate.md#getinstance) - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:54](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L54) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/templates.AccessTemplate.md b/docs/nevermined-sdk/api-reference/classes/templates.AccessTemplate.md deleted file mode 100644 index 6b36c2d0eb..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/templates.AccessTemplate.md +++ /dev/null @@ -1,1562 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [templates](../modules/templates.md) / AccessTemplate - -# Class: AccessTemplate - -[templates](../modules/templates.md).AccessTemplate - -## Hierarchy - -- [`BaseTemplate`](templates.BaseTemplate.md)<`AccessTemplateParams`, `ServiceAccess`\> - - ↳ **`AccessTemplate`** - -## Table of contents - -### Constructors - -- [constructor](templates.AccessTemplate.md#constructor) - -### Properties - -- [contract](templates.AccessTemplate.md#contract) -- [contractName](templates.AccessTemplate.md#contractname) -- [events](templates.AccessTemplate.md#events) -- [version](templates.AccessTemplate.md#version) - -### Accessors - -- [address](templates.AccessTemplate.md#address) -- [artifactsFolder](templates.AccessTemplate.md#artifactsfolder) -- [config](templates.AccessTemplate.md#config) -- [instanceConfig](templates.AccessTemplate.md#instanceconfig) -- [instantiableConfig](templates.AccessTemplate.md#instantiableconfig) -- [logger](templates.AccessTemplate.md#logger) -- [nevermined](templates.AccessTemplate.md#nevermined) -- [web3](templates.AccessTemplate.md#web3) - -### Methods - -- [accept](templates.AccessTemplate.md#accept) -- [addresses](templates.AccessTemplate.md#addresses) -- [agreementId](templates.AccessTemplate.md#agreementid) -- [call](templates.AccessTemplate.md#call) -- [checkExists](templates.AccessTemplate.md#checkexists) -- [conditions](templates.AccessTemplate.md#conditions) -- [createAgreement](templates.AccessTemplate.md#createagreement) -- [createAgreementAndPay](templates.AccessTemplate.md#createagreementandpay) -- [createAgreementFromDDO](templates.AccessTemplate.md#createagreementfromddo) -- [createAgreementWithPaymentFromDDO](templates.AccessTemplate.md#createagreementwithpaymentfromddo) -- [createService](templates.AccessTemplate.md#createservice) -- [description](templates.AccessTemplate.md#description) -- [extraGen](templates.AccessTemplate.md#extragen) -- [findSigner](templates.AccessTemplate.md#findsigner) -- [getAddress](templates.AccessTemplate.md#getaddress) -- [getAgreementCreatedEvent](templates.AccessTemplate.md#getagreementcreatedevent) -- [getAgreementData](templates.AccessTemplate.md#getagreementdata) -- [getAgreementIdsFromDDO](templates.AccessTemplate.md#getagreementidsfromddo) -- [getAgreementStatus](templates.AccessTemplate.md#getagreementstatus) -- [getAgreementsForDID](templates.AccessTemplate.md#getagreementsfordid) -- [getConditionTypes](templates.AccessTemplate.md#getconditiontypes) -- [getConditions](templates.AccessTemplate.md#getconditions) -- [getContract](templates.AccessTemplate.md#getcontract) -- [getFromAddress](templates.AccessTemplate.md#getfromaddress) -- [getInputsOfMethod](templates.AccessTemplate.md#getinputsofmethod) -- [getServiceAgreementTemplate](templates.AccessTemplate.md#getserviceagreementtemplate) -- [getServiceAgreementTemplateConditionByRef](templates.AccessTemplate.md#getserviceagreementtemplateconditionbyref) -- [getServiceAgreementTemplateConditions](templates.AccessTemplate.md#getserviceagreementtemplateconditions) -- [getServiceAgreementTemplateDependencies](templates.AccessTemplate.md#getserviceagreementtemplatedependencies) -- [getSignatureOfMethod](templates.AccessTemplate.md#getsignatureofmethod) -- [init](templates.AccessTemplate.md#init) -- [instanceFromDDO](templates.AccessTemplate.md#instancefromddo) -- [lockConditionIndex](templates.AccessTemplate.md#lockconditionindex) -- [lockTokens](templates.AccessTemplate.md#locktokens) -- [name](templates.AccessTemplate.md#name) -- [params](templates.AccessTemplate.md#params) -- [paramsGen](templates.AccessTemplate.md#paramsgen) -- [paymentData](templates.AccessTemplate.md#paymentdata) -- [printAgreementStatus](templates.AccessTemplate.md#printagreementstatus) -- [process](templates.AccessTemplate.md#process) -- [send](templates.AccessTemplate.md#send) -- [sendFrom](templates.AccessTemplate.md#sendfrom) -- [service](templates.AccessTemplate.md#service) -- [serviceEndpoint](templates.AccessTemplate.md#serviceendpoint) -- [setInstanceConfig](templates.AccessTemplate.md#setinstanceconfig) -- [standardContext](templates.AccessTemplate.md#standardcontext) -- [validateAgreement](templates.AccessTemplate.md#validateagreement) -- [addressesStatic](templates.AccessTemplate.md#addressesstatic) -- [findSignerStatic](templates.AccessTemplate.md#findsignerstatic) -- [getInstance](templates.AccessTemplate.md#getinstance) -- [setInstanceConfig](templates.AccessTemplate.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new AccessTemplate**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[constructor](templates.BaseTemplate.md#constructor) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L75) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contract](templates.BaseTemplate.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contractName](templates.BaseTemplate.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[events](templates.BaseTemplate.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[version](templates.BaseTemplate.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -BaseTemplate.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -BaseTemplate.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -BaseTemplate.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -BaseTemplate.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### accept - -▸ **accept**(`params`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `ValidationParams` | - -#### Returns - -`Promise`<`boolean`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[accept](templates.BaseTemplate.md#accept) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:112](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L112) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addresses](templates.BaseTemplate.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### agreementId - -▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `creator` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[agreementId](templates.BaseTemplate.md#agreementid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[call](templates.BaseTemplate.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[checkExists](templates.BaseTemplate.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### conditions - -▸ **conditions**(): [[`AccessCondition`](conditions.AccessCondition.md), [`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Returns - -[[`AccessCondition`](conditions.AccessCondition.md), [`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[conditions](templates.BaseTemplate.md#conditions) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:62](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L62) - -___ - -### createAgreement - -▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `extraArgs` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreement](templates.BaseTemplate.md#createagreement) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L99) - -___ - -### createAgreementAndPay - -▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `accessConsumer` | `string` | -| `condIdx` | `number` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `default`[] | -| `receivers` | `string`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementAndPay](templates.BaseTemplate.md#createagreementandpay) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L124) - -___ - -### createAgreementFromDDO - -▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `params?`): `Promise`<`string`\> - -Create a new agreement using the data of a DDO. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementIdSeed` | `string` | - | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `parameters` | `AccessTemplateParams` | | -| `consumer` | [`Account`](Account.md) | - | -| `from` | [`Account`](Account.md) | - | -| `timeOuts?` | `number`[] | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`string`\> - -true if the call was successful. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementFromDDO](templates.BaseTemplate.md#createagreementfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L225) - -___ - -### createAgreementWithPaymentFromDDO - -▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`, `observer?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `parameters` | `AccessTemplateParams` | -| `consumer` | [`Account`](Account.md) | -| `from` | [`Account`](Account.md) | -| `timeOuts?` | `number`[] | -| `txParams?` | `TxParameters` | -| `observer?` | (`OrderProgressStep`: `any`) => `void` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementWithPaymentFromDDO](templates.BaseTemplate.md#createagreementwithpaymentfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L255) - -___ - -### createService - -▸ **createService**(`publisher`, `metadata`, `assetRewards?`, `erc20TokenAddress?`, `priced?`): `Promise`<`ServiceAccess`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `publisher` | [`Account`](Account.md) | `undefined` | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | -| `assetRewards?` | `default` | `undefined` | -| `erc20TokenAddress?` | `string` | `undefined` | -| `priced` | `boolean` | `false` | - -#### Returns - -`Promise`<`ServiceAccess`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createService](templates.BaseTemplate.md#createservice) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L65) - -___ - -### description - -▸ **description**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[description](templates.BaseTemplate.md#description) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L35) - -___ - -### extraGen - -▸ **extraGen**(`_params`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[extraGen](templates.BaseTemplate.md#extragen) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSigner](templates.BaseTemplate.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAddress](templates.BaseTemplate.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getAgreementCreatedEvent - -▸ **getAgreementCreatedEvent**(`agreementId`): `Promise`<`any`[]\> - -Generates and returns the agreement creation event. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`any`[]\> - -Agreement created event. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementCreatedEvent](templates.BaseTemplate.md#getagreementcreatedevent) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L469) - -___ - -### getAgreementData - -▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementData](templates.BaseTemplate.md#getagreementdata) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) - -___ - -### getAgreementIdsFromDDO - -▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> - -Get agreement conditions IDs. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `AccessTemplateParams` | - | - -#### Returns - -`Promise`<`string`[]\> - -The condition IDs. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementIdsFromDDO](templates.BaseTemplate.md#getagreementidsfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L183) - -___ - -### getAgreementStatus - -▸ **getAgreementStatus**(`agreementId`): `Promise`<``false`` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -Returns the status of the conditions. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<``false`` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -The conditions status. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementStatus](templates.BaseTemplate.md#getagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L343) - -___ - -### getAgreementsForDID - -▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementsForDID](templates.BaseTemplate.md#getagreementsfordid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L496) - -___ - -### getConditionTypes - -▸ **getConditionTypes**(): `Promise`<`string`[]\> - -Conditions address list. - -#### Returns - -`Promise`<`string`[]\> - -A list of condition addresses. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditionTypes](templates.BaseTemplate.md#getconditiontypes) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L163) - -___ - -### getConditions - -▸ **getConditions**(): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -List of condition contracts. - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -A list of condition contracts. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditions](templates.BaseTemplate.md#getconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L171) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getContract](templates.BaseTemplate.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getFromAddress](templates.BaseTemplate.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getInputsOfMethod](templates.BaseTemplate.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getServiceAgreementTemplate - -▸ **getServiceAgreementTemplate**(): `Promise`<`ServiceAgreementTemplate`\> - -#### Returns - -`Promise`<`ServiceAgreementTemplate`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplate](templates.BaseTemplate.md#getserviceagreementtemplate) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:46](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L46) - -___ - -### getServiceAgreementTemplateConditionByRef - -▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ref` | `string` | - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](templates.BaseTemplate.md#getserviceagreementtemplateconditionbyref) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) - -___ - -### getServiceAgreementTemplateConditions - -▸ **getServiceAgreementTemplateConditions**(): `Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Returns - -`Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditions](templates.BaseTemplate.md#getserviceagreementtemplateconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L319) - -___ - -### getServiceAgreementTemplateDependencies - -▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Returns - -`Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateDependencies](templates.BaseTemplate.md#getserviceagreementtemplatedependencies) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L333) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getSignatureOfMethod](templates.BaseTemplate.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[init](templates.BaseTemplate.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`AccessTemplateParams`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `AccessTemplateParams` | - -#### Returns - -`Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`AccessTemplateParams`\>\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[instanceFromDDO](templates.BaseTemplate.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:68](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L68) - -___ - -### lockConditionIndex - -▸ **lockConditionIndex**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockConditionIndex](templates.BaseTemplate.md#lockconditionindex) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L81) - -___ - -### lockTokens - -▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`Account`](Account.md) | -| `txParams` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockTokens](templates.BaseTemplate.md#locktokens) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L398) - -___ - -### name - -▸ **name**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[name](templates.BaseTemplate.md#name) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L32) - -___ - -### params - -▸ **params**(`consumer`, `serviceType?`): `AccessTemplateParams` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `consumer` | [`Account`](Account.md) | `undefined` | -| `serviceType` | `ServiceType` | `'access'` | - -#### Returns - -`AccessTemplateParams` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[params](templates.BaseTemplate.md#params) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L50) - -___ - -### paramsGen - -▸ **paramsGen**(`__namedParameters`): `Promise`<`AccessTemplateParams`\> - -Specialize params - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `__namedParameters` | `ValidationParams` | Generic parameters | - -#### Returns - -`Promise`<`AccessTemplateParams`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[paramsGen](templates.BaseTemplate.md#paramsgen) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:22](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L22) - -___ - -### paymentData - -▸ **paymentData**(`service`): [`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `service` | `ServiceCommon` | - -#### Returns - -[`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[paymentData](templates.BaseTemplate.md#paymentdata) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L85) - -___ - -### printAgreementStatus - -▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> - -Prints the agreement status. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[printAgreementStatus](templates.BaseTemplate.md#printagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L439) - -___ - -### process - -▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `ValidationParams` | -| `from` | [`Account`](Account.md) | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[process](templates.BaseTemplate.md#process) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L116) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[send](templates.BaseTemplate.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[sendFrom](templates.BaseTemplate.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### service - -▸ **service**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[service](templates.BaseTemplate.md#service) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:42](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L42) - -___ - -### serviceEndpoint - -▸ **serviceEndpoint**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[serviceEndpoint](templates.BaseTemplate.md#serviceendpoint) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### standardContext - -▸ **standardContext**(`ddo`, `creator`): [`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | - -#### Returns - -[`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[standardContext](templates.BaseTemplate.md#standardcontext) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L207) - -___ - -### validateAgreement - -▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `AccessTemplateParams` | -| `from` | [`Account`](Account.md) | -| `extra` | `any` | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[validateAgreement](templates.BaseTemplate.md#validateagreement) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L131) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addressesStatic](templates.BaseTemplate.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSignerStatic](templates.BaseTemplate.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`AccessTemplate`](templates.AccessTemplate.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`AccessTemplate`](templates.AccessTemplate.md)\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getInstance](templates.BaseTemplate.md#getinstance) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:38](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L38) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/templates.BaseTemplate.md b/docs/nevermined-sdk/api-reference/classes/templates.BaseTemplate.md deleted file mode 100644 index f0bc6bcecb..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/templates.BaseTemplate.md +++ /dev/null @@ -1,1594 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [templates](../modules/templates.md) / BaseTemplate - -# Class: BaseTemplate - -[templates](../modules/templates.md).BaseTemplate - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `Params` | `Params` | -| `S` | extends `Service` | - -## Hierarchy - -- [`AgreementTemplate`](AgreementTemplate.md)<`Params`\> - - ↳ **`BaseTemplate`** - - ↳↳ [`AccessTemplate`](templates.AccessTemplate.md) - - ↳↳ [`EscrowComputeExecutionTemplate`](templates.EscrowComputeExecutionTemplate.md) - - ↳↳ [`DIDSalesTemplate`](templates.DIDSalesTemplate.md) - - ↳↳ [`NFTAccessTemplate`](templates.NFTAccessTemplate.md) - - ↳↳ [`NFT721AccessTemplate`](templates.NFT721AccessTemplate.md) - - ↳↳ [`NFTSalesTemplate`](templates.NFTSalesTemplate.md) - - ↳↳ [`NFT721SalesTemplate`](templates.NFT721SalesTemplate.md) - - ↳↳ [`AaveCreditTemplate`](templates.AaveCreditTemplate.md) - -## Implements - -- `ServicePlugin`<`S`\> - -## Table of contents - -### Constructors - -- [constructor](templates.BaseTemplate.md#constructor) - -### Properties - -- [contract](templates.BaseTemplate.md#contract) -- [contractName](templates.BaseTemplate.md#contractname) -- [events](templates.BaseTemplate.md#events) -- [version](templates.BaseTemplate.md#version) - -### Accessors - -- [address](templates.BaseTemplate.md#address) -- [artifactsFolder](templates.BaseTemplate.md#artifactsfolder) -- [config](templates.BaseTemplate.md#config) -- [instanceConfig](templates.BaseTemplate.md#instanceconfig) -- [instantiableConfig](templates.BaseTemplate.md#instantiableconfig) -- [logger](templates.BaseTemplate.md#logger) -- [nevermined](templates.BaseTemplate.md#nevermined) -- [web3](templates.BaseTemplate.md#web3) - -### Methods - -- [accept](templates.BaseTemplate.md#accept) -- [addresses](templates.BaseTemplate.md#addresses) -- [agreementId](templates.BaseTemplate.md#agreementid) -- [call](templates.BaseTemplate.md#call) -- [checkExists](templates.BaseTemplate.md#checkexists) -- [conditions](templates.BaseTemplate.md#conditions) -- [createAgreement](templates.BaseTemplate.md#createagreement) -- [createAgreementAndPay](templates.BaseTemplate.md#createagreementandpay) -- [createAgreementFromDDO](templates.BaseTemplate.md#createagreementfromddo) -- [createAgreementWithPaymentFromDDO](templates.BaseTemplate.md#createagreementwithpaymentfromddo) -- [createService](templates.BaseTemplate.md#createservice) -- [description](templates.BaseTemplate.md#description) -- [extraGen](templates.BaseTemplate.md#extragen) -- [findSigner](templates.BaseTemplate.md#findsigner) -- [getAddress](templates.BaseTemplate.md#getaddress) -- [getAgreementCreatedEvent](templates.BaseTemplate.md#getagreementcreatedevent) -- [getAgreementData](templates.BaseTemplate.md#getagreementdata) -- [getAgreementIdsFromDDO](templates.BaseTemplate.md#getagreementidsfromddo) -- [getAgreementStatus](templates.BaseTemplate.md#getagreementstatus) -- [getAgreementsForDID](templates.BaseTemplate.md#getagreementsfordid) -- [getConditionTypes](templates.BaseTemplate.md#getconditiontypes) -- [getConditions](templates.BaseTemplate.md#getconditions) -- [getContract](templates.BaseTemplate.md#getcontract) -- [getFromAddress](templates.BaseTemplate.md#getfromaddress) -- [getInputsOfMethod](templates.BaseTemplate.md#getinputsofmethod) -- [getPriced](templates.BaseTemplate.md#getpriced) -- [getServiceAgreementTemplate](templates.BaseTemplate.md#getserviceagreementtemplate) -- [getServiceAgreementTemplateConditionByRef](templates.BaseTemplate.md#getserviceagreementtemplateconditionbyref) -- [getServiceAgreementTemplateConditions](templates.BaseTemplate.md#getserviceagreementtemplateconditions) -- [getServiceAgreementTemplateDependencies](templates.BaseTemplate.md#getserviceagreementtemplatedependencies) -- [getSignatureOfMethod](templates.BaseTemplate.md#getsignatureofmethod) -- [init](templates.BaseTemplate.md#init) -- [instanceFromDDO](templates.BaseTemplate.md#instancefromddo) -- [lockConditionIndex](templates.BaseTemplate.md#lockconditionindex) -- [lockTokens](templates.BaseTemplate.md#locktokens) -- [name](templates.BaseTemplate.md#name) -- [params](templates.BaseTemplate.md#params) -- [paramsGen](templates.BaseTemplate.md#paramsgen) -- [paymentData](templates.BaseTemplate.md#paymentdata) -- [printAgreementStatus](templates.BaseTemplate.md#printagreementstatus) -- [process](templates.BaseTemplate.md#process) -- [send](templates.BaseTemplate.md#send) -- [sendFrom](templates.BaseTemplate.md#sendfrom) -- [service](templates.BaseTemplate.md#service) -- [serviceEndpoint](templates.BaseTemplate.md#serviceendpoint) -- [setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig) -- [standardContext](templates.BaseTemplate.md#standardcontext) -- [validateAgreement](templates.BaseTemplate.md#validateagreement) -- [addressesStatic](templates.BaseTemplate.md#addressesstatic) -- [findSignerStatic](templates.BaseTemplate.md#findsignerstatic) -- [getInstance](templates.BaseTemplate.md#getinstance) -- [setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new BaseTemplate**<`Params`, `S`\>(`contractName`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Params` | `Params` | -| `S` | extends `ServiceCommon` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[constructor](AgreementTemplate.md#constructor) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L75) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[contract](AgreementTemplate.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[contractName](AgreementTemplate.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[events](AgreementTemplate.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[version](AgreementTemplate.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -AgreementTemplate.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -AgreementTemplate.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -AgreementTemplate.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -AgreementTemplate.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -AgreementTemplate.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -AgreementTemplate.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -AgreementTemplate.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -AgreementTemplate.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### accept - -▸ **accept**(`_params`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -ServicePlugin.accept - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:112](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L112) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[addresses](AgreementTemplate.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### agreementId - -▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `creator` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[agreementId](AgreementTemplate.md#agreementid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[call](AgreementTemplate.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[checkExists](AgreementTemplate.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### conditions - -▸ `Abstract` **conditions**(): [`Condition`](Condition.md)<`any`, `any`\>[] - -#### Returns - -[`Condition`](Condition.md)<`any`, `any`\>[] - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L29) - -___ - -### createAgreement - -▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `extraArgs` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[createAgreement](AgreementTemplate.md#createagreement) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L99) - -___ - -### createAgreementAndPay - -▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `accessConsumer` | `string` | -| `condIdx` | `number` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `default`[] | -| `receivers` | `string`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[createAgreementAndPay](AgreementTemplate.md#createagreementandpay) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L124) - -___ - -### createAgreementFromDDO - -▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `params?`): `Promise`<`string`\> - -Create a new agreement using the data of a DDO. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementIdSeed` | `string` | - | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `parameters` | `Params` | | -| `consumer` | [`Account`](Account.md) | - | -| `from` | [`Account`](Account.md) | - | -| `timeOuts?` | `number`[] | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`string`\> - -true if the call was successful. - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[createAgreementFromDDO](AgreementTemplate.md#createagreementfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L225) - -___ - -### createAgreementWithPaymentFromDDO - -▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`, `observer?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `parameters` | `Params` | -| `consumer` | [`Account`](Account.md) | -| `from` | [`Account`](Account.md) | -| `timeOuts?` | `number`[] | -| `txParams?` | `TxParameters` | -| `observer?` | (`OrderProgressStep`: `any`) => `void` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[createAgreementWithPaymentFromDDO](AgreementTemplate.md#createagreementwithpaymentfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L255) - -___ - -### createService - -▸ **createService**(`publisher`, `metadata`, `assetRewards?`, `erc20TokenAddress?`, `priced?`): `Promise`<`S`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `publisher` | [`Account`](Account.md) | `undefined` | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | -| `assetRewards?` | `default` | `undefined` | -| `erc20TokenAddress?` | `string` | `undefined` | -| `priced` | `boolean` | `false` | - -#### Returns - -`Promise`<`S`\> - -#### Implementation of - -ServicePlugin.createService - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L65) - -___ - -### description - -▸ `Abstract` **description**(): `string` - -#### Returns - -`string` - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L28) - -___ - -### extraGen - -▸ **extraGen**(`_params`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[findSigner](AgreementTemplate.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getAddress](AgreementTemplate.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getAgreementCreatedEvent - -▸ **getAgreementCreatedEvent**(`agreementId`): `Promise`<`any`[]\> - -Generates and returns the agreement creation event. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`any`[]\> - -Agreement created event. - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getAgreementCreatedEvent](AgreementTemplate.md#getagreementcreatedevent) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L469) - -___ - -### getAgreementData - -▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) - -___ - -### getAgreementIdsFromDDO - -▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> - -Get agreement conditions IDs. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `Params` | - | - -#### Returns - -`Promise`<`string`[]\> - -The condition IDs. - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getAgreementIdsFromDDO](AgreementTemplate.md#getagreementidsfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L183) - -___ - -### getAgreementStatus - -▸ **getAgreementStatus**(`agreementId`): `Promise`<``false`` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -Returns the status of the conditions. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<``false`` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -The conditions status. - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getAgreementStatus](AgreementTemplate.md#getagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L343) - -___ - -### getAgreementsForDID - -▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getAgreementsForDID](AgreementTemplate.md#getagreementsfordid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L496) - -___ - -### getConditionTypes - -▸ **getConditionTypes**(): `Promise`<`string`[]\> - -Conditions address list. - -#### Returns - -`Promise`<`string`[]\> - -A list of condition addresses. - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getConditionTypes](AgreementTemplate.md#getconditiontypes) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L163) - -___ - -### getConditions - -▸ **getConditions**(): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -List of condition contracts. - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -A list of condition contracts. - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getConditions](AgreementTemplate.md#getconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L171) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getContract](AgreementTemplate.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getFromAddress](AgreementTemplate.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getInputsOfMethod](AgreementTemplate.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getPriced - -▸ `Private` **getPriced**(`assetRewards`, `erc20TokenAddress`): `Promise`<`Priced`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `assetRewards` | `default` | -| `erc20TokenAddress` | `string` | - -#### Returns - -`Promise`<`Priced`\> - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L35) - -___ - -### getServiceAgreementTemplate - -▸ `Abstract` **getServiceAgreementTemplate**(): `Promise`<`ServiceAgreementTemplate`\> - -#### Returns - -`Promise`<`ServiceAgreementTemplate`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getServiceAgreementTemplate](AgreementTemplate.md#getserviceagreementtemplate) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:317](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L317) - -___ - -### getServiceAgreementTemplateConditionByRef - -▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ref` | `string` | - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getServiceAgreementTemplateConditionByRef](AgreementTemplate.md#getserviceagreementtemplateconditionbyref) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) - -___ - -### getServiceAgreementTemplateConditions - -▸ **getServiceAgreementTemplateConditions**(): `Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Returns - -`Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getServiceAgreementTemplateConditions](AgreementTemplate.md#getserviceagreementtemplateconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L319) - -___ - -### getServiceAgreementTemplateDependencies - -▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Returns - -`Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getServiceAgreementTemplateDependencies](AgreementTemplate.md#getserviceagreementtemplatedependencies) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L333) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getSignatureOfMethod](AgreementTemplate.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[init](AgreementTemplate.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instanceFromDDO - -▸ `Optional` `Abstract` **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`Params`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `Params` | - -#### Returns - -`Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`Params`\>\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[instanceFromDDO](AgreementTemplate.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:198](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L198) - -___ - -### lockConditionIndex - -▸ **lockConditionIndex**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[lockConditionIndex](AgreementTemplate.md#lockconditionindex) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L81) - -___ - -### lockTokens - -▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`Account`](Account.md) | -| `txParams` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[lockTokens](AgreementTemplate.md#locktokens) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L398) - -___ - -### name - -▸ `Abstract` **name**(): `string` - -#### Returns - -`string` - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:27](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L27) - -___ - -### params - -▸ `Abstract` **params**(...`args`): `Params` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`Params` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[params](AgreementTemplate.md#params) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L79) - -___ - -### paramsGen - -▸ `Abstract` **paramsGen**(`params`): `Promise`<`Params`\> - -Specialize params - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `ValidationParams` | Generic parameters | - -#### Returns - -`Promise`<`Params`\> - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:106](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L106) - -___ - -### paymentData - -▸ **paymentData**(`service`): [`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `service` | `ServiceCommon` | - -#### Returns - -[`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[paymentData](AgreementTemplate.md#paymentdata) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L85) - -___ - -### printAgreementStatus - -▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> - -Prints the agreement status. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[printAgreementStatus](AgreementTemplate.md#printagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L439) - -___ - -### process - -▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `ValidationParams` | -| `from` | [`Account`](Account.md) | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -ServicePlugin.process - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L116) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[send](AgreementTemplate.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[sendFrom](AgreementTemplate.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### service - -▸ `Abstract` **service**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[service](AgreementTemplate.md#service) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:205](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L205) - -___ - -### serviceEndpoint - -▸ **serviceEndpoint**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[setInstanceConfig](AgreementTemplate.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### standardContext - -▸ **standardContext**(`ddo`, `creator`): [`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | - -#### Returns - -[`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[standardContext](AgreementTemplate.md#standardcontext) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L207) - -___ - -### validateAgreement - -▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `Params` | -| `from` | [`Account`](Account.md) | -| `extra` | `any` | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L131) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[addressesStatic](AgreementTemplate.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[findSignerStatic](AgreementTemplate.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**<`Params`\>(`config`, `templateContractName`, `templateClass`, `optional?`): `Promise`<`any`\> - -#### Type parameters - -| Name | -| :------ | -| `Params` | - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `templateContractName` | `string` | `undefined` | -| `templateClass` | `any` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getInstance](AgreementTemplate.md#getinstance) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:62](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L62) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[setInstanceConfig](AgreementTemplate.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/templates.DIDSalesTemplate.md b/docs/nevermined-sdk/api-reference/classes/templates.DIDSalesTemplate.md deleted file mode 100644 index a8e7656b9a..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/templates.DIDSalesTemplate.md +++ /dev/null @@ -1,1561 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [templates](../modules/templates.md) / DIDSalesTemplate - -# Class: DIDSalesTemplate - -[templates](../modules/templates.md).DIDSalesTemplate - -## Hierarchy - -- [`BaseTemplate`](templates.BaseTemplate.md)<`DIDSalesTemplateParams`, `any`\> - - ↳ **`DIDSalesTemplate`** - -## Table of contents - -### Constructors - -- [constructor](templates.DIDSalesTemplate.md#constructor) - -### Properties - -- [contract](templates.DIDSalesTemplate.md#contract) -- [contractName](templates.DIDSalesTemplate.md#contractname) -- [events](templates.DIDSalesTemplate.md#events) -- [version](templates.DIDSalesTemplate.md#version) - -### Accessors - -- [address](templates.DIDSalesTemplate.md#address) -- [artifactsFolder](templates.DIDSalesTemplate.md#artifactsfolder) -- [config](templates.DIDSalesTemplate.md#config) -- [instanceConfig](templates.DIDSalesTemplate.md#instanceconfig) -- [instantiableConfig](templates.DIDSalesTemplate.md#instantiableconfig) -- [logger](templates.DIDSalesTemplate.md#logger) -- [nevermined](templates.DIDSalesTemplate.md#nevermined) -- [web3](templates.DIDSalesTemplate.md#web3) - -### Methods - -- [accept](templates.DIDSalesTemplate.md#accept) -- [addresses](templates.DIDSalesTemplate.md#addresses) -- [agreementId](templates.DIDSalesTemplate.md#agreementid) -- [call](templates.DIDSalesTemplate.md#call) -- [checkExists](templates.DIDSalesTemplate.md#checkexists) -- [conditions](templates.DIDSalesTemplate.md#conditions) -- [createAgreement](templates.DIDSalesTemplate.md#createagreement) -- [createAgreementAndPay](templates.DIDSalesTemplate.md#createagreementandpay) -- [createAgreementFromDDO](templates.DIDSalesTemplate.md#createagreementfromddo) -- [createAgreementWithPaymentFromDDO](templates.DIDSalesTemplate.md#createagreementwithpaymentfromddo) -- [createService](templates.DIDSalesTemplate.md#createservice) -- [description](templates.DIDSalesTemplate.md#description) -- [extraGen](templates.DIDSalesTemplate.md#extragen) -- [findSigner](templates.DIDSalesTemplate.md#findsigner) -- [getAddress](templates.DIDSalesTemplate.md#getaddress) -- [getAgreementCreatedEvent](templates.DIDSalesTemplate.md#getagreementcreatedevent) -- [getAgreementData](templates.DIDSalesTemplate.md#getagreementdata) -- [getAgreementIdsFromDDO](templates.DIDSalesTemplate.md#getagreementidsfromddo) -- [getAgreementStatus](templates.DIDSalesTemplate.md#getagreementstatus) -- [getAgreementsForDID](templates.DIDSalesTemplate.md#getagreementsfordid) -- [getConditionTypes](templates.DIDSalesTemplate.md#getconditiontypes) -- [getConditions](templates.DIDSalesTemplate.md#getconditions) -- [getContract](templates.DIDSalesTemplate.md#getcontract) -- [getFromAddress](templates.DIDSalesTemplate.md#getfromaddress) -- [getInputsOfMethod](templates.DIDSalesTemplate.md#getinputsofmethod) -- [getServiceAgreementTemplate](templates.DIDSalesTemplate.md#getserviceagreementtemplate) -- [getServiceAgreementTemplateConditionByRef](templates.DIDSalesTemplate.md#getserviceagreementtemplateconditionbyref) -- [getServiceAgreementTemplateConditions](templates.DIDSalesTemplate.md#getserviceagreementtemplateconditions) -- [getServiceAgreementTemplateDependencies](templates.DIDSalesTemplate.md#getserviceagreementtemplatedependencies) -- [getSignatureOfMethod](templates.DIDSalesTemplate.md#getsignatureofmethod) -- [init](templates.DIDSalesTemplate.md#init) -- [instanceFromDDO](templates.DIDSalesTemplate.md#instancefromddo) -- [lockConditionIndex](templates.DIDSalesTemplate.md#lockconditionindex) -- [lockTokens](templates.DIDSalesTemplate.md#locktokens) -- [name](templates.DIDSalesTemplate.md#name) -- [params](templates.DIDSalesTemplate.md#params) -- [paramsGen](templates.DIDSalesTemplate.md#paramsgen) -- [paymentData](templates.DIDSalesTemplate.md#paymentdata) -- [printAgreementStatus](templates.DIDSalesTemplate.md#printagreementstatus) -- [process](templates.DIDSalesTemplate.md#process) -- [send](templates.DIDSalesTemplate.md#send) -- [sendFrom](templates.DIDSalesTemplate.md#sendfrom) -- [service](templates.DIDSalesTemplate.md#service) -- [serviceEndpoint](templates.DIDSalesTemplate.md#serviceendpoint) -- [setInstanceConfig](templates.DIDSalesTemplate.md#setinstanceconfig) -- [standardContext](templates.DIDSalesTemplate.md#standardcontext) -- [validateAgreement](templates.DIDSalesTemplate.md#validateagreement) -- [addressesStatic](templates.DIDSalesTemplate.md#addressesstatic) -- [findSignerStatic](templates.DIDSalesTemplate.md#findsignerstatic) -- [getInstance](templates.DIDSalesTemplate.md#getinstance) -- [setInstanceConfig](templates.DIDSalesTemplate.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new DIDSalesTemplate**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[constructor](templates.BaseTemplate.md#constructor) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L75) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contract](templates.BaseTemplate.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contractName](templates.BaseTemplate.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[events](templates.BaseTemplate.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[version](templates.BaseTemplate.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -BaseTemplate.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -BaseTemplate.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -BaseTemplate.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -BaseTemplate.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### accept - -▸ **accept**(`_params`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[accept](templates.BaseTemplate.md#accept) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:112](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L112) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addresses](templates.BaseTemplate.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### agreementId - -▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `creator` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[agreementId](templates.BaseTemplate.md#agreementid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[call](templates.BaseTemplate.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[checkExists](templates.BaseTemplate.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### conditions - -▸ **conditions**(): [[`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`TransferDIDOwnershipCondition`](conditions.TransferDIDOwnershipCondition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Returns - -[[`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`TransferDIDOwnershipCondition`](conditions.TransferDIDOwnershipCondition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[conditions](templates.BaseTemplate.md#conditions) - -#### Defined in - -[src/keeper/contracts/templates/DIDSalesTemplate.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/DIDSalesTemplate.ts#L33) - -___ - -### createAgreement - -▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `extraArgs` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreement](templates.BaseTemplate.md#createagreement) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L99) - -___ - -### createAgreementAndPay - -▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `accessConsumer` | `string` | -| `condIdx` | `number` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `default`[] | -| `receivers` | `string`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementAndPay](templates.BaseTemplate.md#createagreementandpay) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L124) - -___ - -### createAgreementFromDDO - -▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `params?`): `Promise`<`string`\> - -Create a new agreement using the data of a DDO. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementIdSeed` | `string` | - | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `parameters` | `DIDSalesTemplateParams` | | -| `consumer` | [`Account`](Account.md) | - | -| `from` | [`Account`](Account.md) | - | -| `timeOuts?` | `number`[] | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`string`\> - -true if the call was successful. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementFromDDO](templates.BaseTemplate.md#createagreementfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L225) - -___ - -### createAgreementWithPaymentFromDDO - -▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`, `observer?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `parameters` | `DIDSalesTemplateParams` | -| `consumer` | [`Account`](Account.md) | -| `from` | [`Account`](Account.md) | -| `timeOuts?` | `number`[] | -| `txParams?` | `TxParameters` | -| `observer?` | (`OrderProgressStep`: `any`) => `void` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementWithPaymentFromDDO](templates.BaseTemplate.md#createagreementwithpaymentfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L255) - -___ - -### createService - -▸ **createService**(`publisher`, `metadata`, `assetRewards?`, `erc20TokenAddress?`, `priced?`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `publisher` | [`Account`](Account.md) | `undefined` | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | -| `assetRewards?` | `default` | `undefined` | -| `erc20TokenAddress?` | `string` | `undefined` | -| `priced` | `boolean` | `false` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createService](templates.BaseTemplate.md#createservice) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L65) - -___ - -### description - -▸ **description**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[description](templates.BaseTemplate.md#description) - -#### Defined in - -[src/keeper/contracts/templates/DIDSalesTemplate.ts:29](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/DIDSalesTemplate.ts#L29) - -___ - -### extraGen - -▸ **extraGen**(`_params`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[extraGen](templates.BaseTemplate.md#extragen) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSigner](templates.BaseTemplate.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAddress](templates.BaseTemplate.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getAgreementCreatedEvent - -▸ **getAgreementCreatedEvent**(`agreementId`): `Promise`<`any`[]\> - -Generates and returns the agreement creation event. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`any`[]\> - -Agreement created event. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementCreatedEvent](templates.BaseTemplate.md#getagreementcreatedevent) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L469) - -___ - -### getAgreementData - -▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementData](templates.BaseTemplate.md#getagreementdata) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) - -___ - -### getAgreementIdsFromDDO - -▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> - -Get agreement conditions IDs. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `DIDSalesTemplateParams` | - | - -#### Returns - -`Promise`<`string`[]\> - -The condition IDs. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementIdsFromDDO](templates.BaseTemplate.md#getagreementidsfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L183) - -___ - -### getAgreementStatus - -▸ **getAgreementStatus**(`agreementId`): `Promise`<``false`` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -Returns the status of the conditions. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<``false`` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -The conditions status. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementStatus](templates.BaseTemplate.md#getagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L343) - -___ - -### getAgreementsForDID - -▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementsForDID](templates.BaseTemplate.md#getagreementsfordid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L496) - -___ - -### getConditionTypes - -▸ **getConditionTypes**(): `Promise`<`string`[]\> - -Conditions address list. - -#### Returns - -`Promise`<`string`[]\> - -A list of condition addresses. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditionTypes](templates.BaseTemplate.md#getconditiontypes) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L163) - -___ - -### getConditions - -▸ **getConditions**(): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -List of condition contracts. - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -A list of condition contracts. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditions](templates.BaseTemplate.md#getconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L171) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getContract](templates.BaseTemplate.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getFromAddress](templates.BaseTemplate.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getInputsOfMethod](templates.BaseTemplate.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getServiceAgreementTemplate - -▸ **getServiceAgreementTemplate**(): `Promise`<`ServiceAgreementTemplate`\> - -#### Returns - -`Promise`<`ServiceAgreementTemplate`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplate](templates.BaseTemplate.md#getserviceagreementtemplate) - -#### Defined in - -[src/keeper/contracts/templates/DIDSalesTemplate.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/DIDSalesTemplate.ts#L105) - -___ - -### getServiceAgreementTemplateConditionByRef - -▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ref` | `string` | - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](templates.BaseTemplate.md#getserviceagreementtemplateconditionbyref) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) - -___ - -### getServiceAgreementTemplateConditions - -▸ **getServiceAgreementTemplateConditions**(): `Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Returns - -`Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditions](templates.BaseTemplate.md#getserviceagreementtemplateconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L319) - -___ - -### getServiceAgreementTemplateDependencies - -▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Returns - -`Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateDependencies](templates.BaseTemplate.md#getserviceagreementtemplatedependencies) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L333) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getSignatureOfMethod](templates.BaseTemplate.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[init](templates.BaseTemplate.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`DIDSalesTemplateParams`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `DIDSalesTemplateParams` | - -#### Returns - -`Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`DIDSalesTemplateParams`\>\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[instanceFromDDO](templates.BaseTemplate.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/templates/DIDSalesTemplate.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/DIDSalesTemplate.ts#L50) - -___ - -### lockConditionIndex - -▸ **lockConditionIndex**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockConditionIndex](templates.BaseTemplate.md#lockconditionindex) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L81) - -___ - -### lockTokens - -▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`Account`](Account.md) | -| `txParams` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockTokens](templates.BaseTemplate.md#locktokens) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L398) - -___ - -### name - -▸ **name**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[name](templates.BaseTemplate.md#name) - -#### Defined in - -[src/keeper/contracts/templates/DIDSalesTemplate.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/DIDSalesTemplate.ts#L26) - -___ - -### params - -▸ **params**(`receiverId`): `DIDSalesTemplateParams` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `receiverId` | `string` | - -#### Returns - -`DIDSalesTemplateParams` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[params](templates.BaseTemplate.md#params) - -#### Defined in - -[src/keeper/contracts/templates/DIDSalesTemplate.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/DIDSalesTemplate.ts#L23) - -___ - -### paramsGen - -▸ **paramsGen**(`params`): `Promise`<`DIDSalesTemplateParams`\> - -Specialize params - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `ValidationParams` | Generic parameters | - -#### Returns - -`Promise`<`DIDSalesTemplateParams`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[paramsGen](templates.BaseTemplate.md#paramsgen) - -#### Defined in - -[src/keeper/contracts/templates/DIDSalesTemplate.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/DIDSalesTemplate.ts#L20) - -___ - -### paymentData - -▸ **paymentData**(`service`): [`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `service` | `ServiceCommon` | - -#### Returns - -[`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[paymentData](templates.BaseTemplate.md#paymentdata) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L85) - -___ - -### printAgreementStatus - -▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> - -Prints the agreement status. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[printAgreementStatus](templates.BaseTemplate.md#printagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L439) - -___ - -### process - -▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `ValidationParams` | -| `from` | [`Account`](Account.md) | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[process](templates.BaseTemplate.md#process) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L116) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[send](templates.BaseTemplate.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[sendFrom](templates.BaseTemplate.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### service - -▸ **service**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[service](templates.BaseTemplate.md#service) - -#### Defined in - -[src/keeper/contracts/templates/DIDSalesTemplate.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/DIDSalesTemplate.ts#L96) - -___ - -### serviceEndpoint - -▸ **serviceEndpoint**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[serviceEndpoint](templates.BaseTemplate.md#serviceendpoint) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### standardContext - -▸ **standardContext**(`ddo`, `creator`): [`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | - -#### Returns - -[`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[standardContext](templates.BaseTemplate.md#standardcontext) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L207) - -___ - -### validateAgreement - -▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `DIDSalesTemplateParams` | -| `from` | [`Account`](Account.md) | -| `extra` | `any` | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[validateAgreement](templates.BaseTemplate.md#validateagreement) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L131) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addressesStatic](templates.BaseTemplate.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSignerStatic](templates.BaseTemplate.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`DIDSalesTemplate`](templates.DIDSalesTemplate.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`DIDSalesTemplate`](templates.DIDSalesTemplate.md)\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getInstance](templates.BaseTemplate.md#getinstance) - -#### Defined in - -[src/keeper/contracts/templates/DIDSalesTemplate.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/DIDSalesTemplate.ts#L99) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/templates.EscrowComputeExecutionTemplate.md b/docs/nevermined-sdk/api-reference/classes/templates.EscrowComputeExecutionTemplate.md deleted file mode 100644 index dab46cf3da..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/templates.EscrowComputeExecutionTemplate.md +++ /dev/null @@ -1,1576 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [templates](../modules/templates.md) / EscrowComputeExecutionTemplate - -# Class: EscrowComputeExecutionTemplate - -[templates](../modules/templates.md).EscrowComputeExecutionTemplate - -## Hierarchy - -- [`BaseTemplate`](templates.BaseTemplate.md)<`EscrowComputeExecutionParams`, `ServiceCompute`\> - - ↳ **`EscrowComputeExecutionTemplate`** - -## Table of contents - -### Constructors - -- [constructor](templates.EscrowComputeExecutionTemplate.md#constructor) - -### Properties - -- [contract](templates.EscrowComputeExecutionTemplate.md#contract) -- [contractName](templates.EscrowComputeExecutionTemplate.md#contractname) -- [events](templates.EscrowComputeExecutionTemplate.md#events) -- [version](templates.EscrowComputeExecutionTemplate.md#version) - -### Accessors - -- [address](templates.EscrowComputeExecutionTemplate.md#address) -- [artifactsFolder](templates.EscrowComputeExecutionTemplate.md#artifactsfolder) -- [config](templates.EscrowComputeExecutionTemplate.md#config) -- [instanceConfig](templates.EscrowComputeExecutionTemplate.md#instanceconfig) -- [instantiableConfig](templates.EscrowComputeExecutionTemplate.md#instantiableconfig) -- [logger](templates.EscrowComputeExecutionTemplate.md#logger) -- [nevermined](templates.EscrowComputeExecutionTemplate.md#nevermined) -- [web3](templates.EscrowComputeExecutionTemplate.md#web3) - -### Methods - -- [accept](templates.EscrowComputeExecutionTemplate.md#accept) -- [addresses](templates.EscrowComputeExecutionTemplate.md#addresses) -- [agreementId](templates.EscrowComputeExecutionTemplate.md#agreementid) -- [call](templates.EscrowComputeExecutionTemplate.md#call) -- [checkExists](templates.EscrowComputeExecutionTemplate.md#checkexists) -- [conditions](templates.EscrowComputeExecutionTemplate.md#conditions) -- [createAgreement](templates.EscrowComputeExecutionTemplate.md#createagreement) -- [createAgreementAndPay](templates.EscrowComputeExecutionTemplate.md#createagreementandpay) -- [createAgreementFromDDO](templates.EscrowComputeExecutionTemplate.md#createagreementfromddo) -- [createAgreementWithPaymentFromDDO](templates.EscrowComputeExecutionTemplate.md#createagreementwithpaymentfromddo) -- [createService](templates.EscrowComputeExecutionTemplate.md#createservice) -- [description](templates.EscrowComputeExecutionTemplate.md#description) -- [extraGen](templates.EscrowComputeExecutionTemplate.md#extragen) -- [findSigner](templates.EscrowComputeExecutionTemplate.md#findsigner) -- [getAddress](templates.EscrowComputeExecutionTemplate.md#getaddress) -- [getAgreementCreatedEvent](templates.EscrowComputeExecutionTemplate.md#getagreementcreatedevent) -- [getAgreementData](templates.EscrowComputeExecutionTemplate.md#getagreementdata) -- [getAgreementIdsFromDDO](templates.EscrowComputeExecutionTemplate.md#getagreementidsfromddo) -- [getAgreementStatus](templates.EscrowComputeExecutionTemplate.md#getagreementstatus) -- [getAgreementsForDID](templates.EscrowComputeExecutionTemplate.md#getagreementsfordid) -- [getConditionTypes](templates.EscrowComputeExecutionTemplate.md#getconditiontypes) -- [getConditions](templates.EscrowComputeExecutionTemplate.md#getconditions) -- [getContract](templates.EscrowComputeExecutionTemplate.md#getcontract) -- [getFromAddress](templates.EscrowComputeExecutionTemplate.md#getfromaddress) -- [getInputsOfMethod](templates.EscrowComputeExecutionTemplate.md#getinputsofmethod) -- [getServiceAgreementTemplate](templates.EscrowComputeExecutionTemplate.md#getserviceagreementtemplate) -- [getServiceAgreementTemplateConditionByRef](templates.EscrowComputeExecutionTemplate.md#getserviceagreementtemplateconditionbyref) -- [getServiceAgreementTemplateConditions](templates.EscrowComputeExecutionTemplate.md#getserviceagreementtemplateconditions) -- [getServiceAgreementTemplateDependencies](templates.EscrowComputeExecutionTemplate.md#getserviceagreementtemplatedependencies) -- [getSignatureOfMethod](templates.EscrowComputeExecutionTemplate.md#getsignatureofmethod) -- [init](templates.EscrowComputeExecutionTemplate.md#init) -- [instanceFromDDO](templates.EscrowComputeExecutionTemplate.md#instancefromddo) -- [lockConditionIndex](templates.EscrowComputeExecutionTemplate.md#lockconditionindex) -- [lockTokens](templates.EscrowComputeExecutionTemplate.md#locktokens) -- [name](templates.EscrowComputeExecutionTemplate.md#name) -- [params](templates.EscrowComputeExecutionTemplate.md#params) -- [paramsGen](templates.EscrowComputeExecutionTemplate.md#paramsgen) -- [paymentData](templates.EscrowComputeExecutionTemplate.md#paymentdata) -- [printAgreementStatus](templates.EscrowComputeExecutionTemplate.md#printagreementstatus) -- [process](templates.EscrowComputeExecutionTemplate.md#process) -- [providerConfig](templates.EscrowComputeExecutionTemplate.md#providerconfig) -- [send](templates.EscrowComputeExecutionTemplate.md#send) -- [sendFrom](templates.EscrowComputeExecutionTemplate.md#sendfrom) -- [service](templates.EscrowComputeExecutionTemplate.md#service) -- [serviceEndpoint](templates.EscrowComputeExecutionTemplate.md#serviceendpoint) -- [setInstanceConfig](templates.EscrowComputeExecutionTemplate.md#setinstanceconfig) -- [standardContext](templates.EscrowComputeExecutionTemplate.md#standardcontext) -- [validateAgreement](templates.EscrowComputeExecutionTemplate.md#validateagreement) -- [addressesStatic](templates.EscrowComputeExecutionTemplate.md#addressesstatic) -- [findSignerStatic](templates.EscrowComputeExecutionTemplate.md#findsignerstatic) -- [getInstance](templates.EscrowComputeExecutionTemplate.md#getinstance) -- [setInstanceConfig](templates.EscrowComputeExecutionTemplate.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new EscrowComputeExecutionTemplate**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[constructor](templates.BaseTemplate.md#constructor) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L75) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contract](templates.BaseTemplate.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contractName](templates.BaseTemplate.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[events](templates.BaseTemplate.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[version](templates.BaseTemplate.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -BaseTemplate.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -BaseTemplate.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -BaseTemplate.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -BaseTemplate.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### accept - -▸ **accept**(`_params`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[accept](templates.BaseTemplate.md#accept) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:112](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L112) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addresses](templates.BaseTemplate.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### agreementId - -▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `creator` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[agreementId](templates.BaseTemplate.md#agreementid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[call](templates.BaseTemplate.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[checkExists](templates.BaseTemplate.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### conditions - -▸ **conditions**(): [[`ComputeExecutionCondition`](conditions.ComputeExecutionCondition.md), [`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Returns - -[[`ComputeExecutionCondition`](conditions.ComputeExecutionCondition.md), [`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[conditions](templates.BaseTemplate.md#conditions) - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:107](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L107) - -___ - -### createAgreement - -▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `extraArgs` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreement](templates.BaseTemplate.md#createagreement) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L99) - -___ - -### createAgreementAndPay - -▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `accessConsumer` | `string` | -| `condIdx` | `number` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `default`[] | -| `receivers` | `string`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementAndPay](templates.BaseTemplate.md#createagreementandpay) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L124) - -___ - -### createAgreementFromDDO - -▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `params?`): `Promise`<`string`\> - -Create a new agreement using the data of a DDO. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementIdSeed` | `string` | - | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `parameters` | `EscrowComputeExecutionParams` | | -| `consumer` | [`Account`](Account.md) | - | -| `from` | [`Account`](Account.md) | - | -| `timeOuts?` | `number`[] | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`string`\> - -true if the call was successful. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementFromDDO](templates.BaseTemplate.md#createagreementfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L225) - -___ - -### createAgreementWithPaymentFromDDO - -▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`, `observer?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `parameters` | `EscrowComputeExecutionParams` | -| `consumer` | [`Account`](Account.md) | -| `from` | [`Account`](Account.md) | -| `timeOuts?` | `number`[] | -| `txParams?` | `TxParameters` | -| `observer?` | (`OrderProgressStep`: `any`) => `void` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementWithPaymentFromDDO](templates.BaseTemplate.md#createagreementwithpaymentfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L255) - -___ - -### createService - -▸ **createService**(`publisher`, `metadata`, `assetRewards?`, `erc20TokenAddress?`, `priced?`): `Promise`<`ServiceCompute`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `publisher` | [`Account`](Account.md) | `undefined` | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | -| `assetRewards?` | `default` | `undefined` | -| `erc20TokenAddress?` | `string` | `undefined` | -| `priced` | `boolean` | `false` | - -#### Returns - -`Promise`<`ServiceCompute`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createService](templates.BaseTemplate.md#createservice) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L65) - -___ - -### description - -▸ **description**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[description](templates.BaseTemplate.md#description) - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:42](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L42) - -___ - -### extraGen - -▸ **extraGen**(`_params`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[extraGen](templates.BaseTemplate.md#extragen) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSigner](templates.BaseTemplate.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAddress](templates.BaseTemplate.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getAgreementCreatedEvent - -▸ **getAgreementCreatedEvent**(`agreementId`): `Promise`<`any`[]\> - -Generates and returns the agreement creation event. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`any`[]\> - -Agreement created event. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementCreatedEvent](templates.BaseTemplate.md#getagreementcreatedevent) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L469) - -___ - -### getAgreementData - -▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementData](templates.BaseTemplate.md#getagreementdata) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) - -___ - -### getAgreementIdsFromDDO - -▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> - -Get agreement conditions IDs. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `EscrowComputeExecutionParams` | - | - -#### Returns - -`Promise`<`string`[]\> - -The condition IDs. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementIdsFromDDO](templates.BaseTemplate.md#getagreementidsfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L183) - -___ - -### getAgreementStatus - -▸ **getAgreementStatus**(`agreementId`): `Promise`<``false`` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -Returns the status of the conditions. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<``false`` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -The conditions status. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementStatus](templates.BaseTemplate.md#getagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L343) - -___ - -### getAgreementsForDID - -▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementsForDID](templates.BaseTemplate.md#getagreementsfordid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L496) - -___ - -### getConditionTypes - -▸ **getConditionTypes**(): `Promise`<`string`[]\> - -Conditions address list. - -#### Returns - -`Promise`<`string`[]\> - -A list of condition addresses. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditionTypes](templates.BaseTemplate.md#getconditiontypes) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L163) - -___ - -### getConditions - -▸ **getConditions**(): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -List of condition contracts. - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -A list of condition contracts. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditions](templates.BaseTemplate.md#getconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L171) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getContract](templates.BaseTemplate.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getFromAddress](templates.BaseTemplate.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getInputsOfMethod](templates.BaseTemplate.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getServiceAgreementTemplate - -▸ **getServiceAgreementTemplate**(): `Promise`<`ServiceAgreementTemplate`\> - -#### Returns - -`Promise`<`ServiceAgreementTemplate`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplate](templates.BaseTemplate.md#getserviceagreementtemplate) - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:95](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L95) - -___ - -### getServiceAgreementTemplateConditionByRef - -▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ref` | `string` | - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](templates.BaseTemplate.md#getserviceagreementtemplateconditionbyref) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) - -___ - -### getServiceAgreementTemplateConditions - -▸ **getServiceAgreementTemplateConditions**(): `Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Returns - -`Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditions](templates.BaseTemplate.md#getserviceagreementtemplateconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L319) - -___ - -### getServiceAgreementTemplateDependencies - -▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Returns - -`Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateDependencies](templates.BaseTemplate.md#getserviceagreementtemplatedependencies) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L333) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getSignatureOfMethod](templates.BaseTemplate.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[init](templates.BaseTemplate.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`EscrowComputeExecutionParams`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `EscrowComputeExecutionParams` | - -#### Returns - -`Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`EscrowComputeExecutionParams`\>\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[instanceFromDDO](templates.BaseTemplate.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:120](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L120) - -___ - -### lockConditionIndex - -▸ **lockConditionIndex**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockConditionIndex](templates.BaseTemplate.md#lockconditionindex) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L81) - -___ - -### lockTokens - -▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`Account`](Account.md) | -| `txParams` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockTokens](templates.BaseTemplate.md#locktokens) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L398) - -___ - -### name - -▸ **name**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[name](templates.BaseTemplate.md#name) - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:39](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L39) - -___ - -### params - -▸ **params**(`consumer`): `EscrowComputeExecutionParams` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `consumer` | [`Account`](Account.md) | - -#### Returns - -`EscrowComputeExecutionParams` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[params](templates.BaseTemplate.md#params) - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:103](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L103) - -___ - -### paramsGen - -▸ **paramsGen**(`params`): `Promise`<`EscrowComputeExecutionParams`\> - -Specialize params - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `ValidationParams` | Generic parameters | - -#### Returns - -`Promise`<`EscrowComputeExecutionParams`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[paramsGen](templates.BaseTemplate.md#paramsgen) - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L23) - -___ - -### paymentData - -▸ **paymentData**(`service`): [`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `service` | `ServiceCommon` | - -#### Returns - -[`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[paymentData](templates.BaseTemplate.md#paymentdata) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L85) - -___ - -### printAgreementStatus - -▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> - -Prints the agreement status. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[printAgreementStatus](templates.BaseTemplate.md#printagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L439) - -___ - -### process - -▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `ValidationParams` | -| `from` | [`Account`](Account.md) | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[process](templates.BaseTemplate.md#process) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L116) - -___ - -### providerConfig - -▸ **providerConfig**(): `Promise`<{ `description`: `string` = ''; `environment`: { `cluster`: { `type`: `string` = 'Kubernetes'; `url`: `string` = 'http://10.0.0.17/xxx' } ; `supportedContainers`: { `checksum`: `string` = 'sha256:cb57ecfa6ebbefd8ffc7f75c0f00e57a7fa739578a429b6f72a0df19315deadc'; `image`: `string` = 'tensorflow/tensorflow'; `tag`: `string` = 'latest' }[] ; `supportedServers`: { `cpu`: `string` = '16'; `disk`: `string` = '160gb'; `gpu`: `string` = '0'; `maxExecutionTime`: `number` = 86400; `memory`: `string` = '128gb'; `price`: `string` = '50'; `serverId`: `string` = '1'; `serverType`: `string` = 'xlsize' }[] } ; `type`: `string` = 'Azure' }\> - -#### Returns - -`Promise`<{ `description`: `string` = ''; `environment`: { `cluster`: { `type`: `string` = 'Kubernetes'; `url`: `string` = 'http://10.0.0.17/xxx' } ; `supportedContainers`: { `checksum`: `string` = 'sha256:cb57ecfa6ebbefd8ffc7f75c0f00e57a7fa739578a429b6f72a0df19315deadc'; `image`: `string` = 'tensorflow/tensorflow'; `tag`: `string` = 'latest' }[] ; `supportedServers`: { `cpu`: `string` = '16'; `disk`: `string` = '160gb'; `gpu`: `string` = '0'; `maxExecutionTime`: `number` = 86400; `memory`: `string` = '128gb'; `price`: `string` = '50'; `serverId`: `string` = '1'; `serverType`: `string` = 'xlsize' }[] } ; `type`: `string` = 'Azure' }\> - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:46](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L46) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[send](templates.BaseTemplate.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[sendFrom](templates.BaseTemplate.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### service - -▸ **service**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[service](templates.BaseTemplate.md#service) - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L99) - -___ - -### serviceEndpoint - -▸ **serviceEndpoint**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[serviceEndpoint](templates.BaseTemplate.md#serviceendpoint) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### standardContext - -▸ **standardContext**(`ddo`, `creator`): [`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | - -#### Returns - -[`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[standardContext](templates.BaseTemplate.md#standardcontext) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L207) - -___ - -### validateAgreement - -▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `EscrowComputeExecutionParams` | -| `from` | [`Account`](Account.md) | -| `extra` | `any` | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[validateAgreement](templates.BaseTemplate.md#validateagreement) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L131) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addressesStatic](templates.BaseTemplate.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSignerStatic](templates.BaseTemplate.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`EscrowComputeExecutionTemplate`](templates.EscrowComputeExecutionTemplate.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`EscrowComputeExecutionTemplate`](templates.EscrowComputeExecutionTemplate.md)\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getInstance](templates.BaseTemplate.md#getinstance) - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L30) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/templates.NFT721AccessTemplate.md b/docs/nevermined-sdk/api-reference/classes/templates.NFT721AccessTemplate.md deleted file mode 100644 index 5bd1783d9b..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/templates.NFT721AccessTemplate.md +++ /dev/null @@ -1,1561 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [templates](../modules/templates.md) / NFT721AccessTemplate - -# Class: NFT721AccessTemplate - -[templates](../modules/templates.md).NFT721AccessTemplate - -## Hierarchy - -- [`BaseTemplate`](templates.BaseTemplate.md)<`NFT721AccessTemplateParams`, `ServiceNFTAccess`\> - - ↳ **`NFT721AccessTemplate`** - -## Table of contents - -### Constructors - -- [constructor](templates.NFT721AccessTemplate.md#constructor) - -### Properties - -- [contract](templates.NFT721AccessTemplate.md#contract) -- [contractName](templates.NFT721AccessTemplate.md#contractname) -- [events](templates.NFT721AccessTemplate.md#events) -- [version](templates.NFT721AccessTemplate.md#version) - -### Accessors - -- [address](templates.NFT721AccessTemplate.md#address) -- [artifactsFolder](templates.NFT721AccessTemplate.md#artifactsfolder) -- [config](templates.NFT721AccessTemplate.md#config) -- [instanceConfig](templates.NFT721AccessTemplate.md#instanceconfig) -- [instantiableConfig](templates.NFT721AccessTemplate.md#instantiableconfig) -- [logger](templates.NFT721AccessTemplate.md#logger) -- [nevermined](templates.NFT721AccessTemplate.md#nevermined) -- [web3](templates.NFT721AccessTemplate.md#web3) - -### Methods - -- [accept](templates.NFT721AccessTemplate.md#accept) -- [addresses](templates.NFT721AccessTemplate.md#addresses) -- [agreementId](templates.NFT721AccessTemplate.md#agreementid) -- [call](templates.NFT721AccessTemplate.md#call) -- [checkExists](templates.NFT721AccessTemplate.md#checkexists) -- [conditions](templates.NFT721AccessTemplate.md#conditions) -- [createAgreement](templates.NFT721AccessTemplate.md#createagreement) -- [createAgreementAndPay](templates.NFT721AccessTemplate.md#createagreementandpay) -- [createAgreementFromDDO](templates.NFT721AccessTemplate.md#createagreementfromddo) -- [createAgreementWithPaymentFromDDO](templates.NFT721AccessTemplate.md#createagreementwithpaymentfromddo) -- [createService](templates.NFT721AccessTemplate.md#createservice) -- [description](templates.NFT721AccessTemplate.md#description) -- [extraGen](templates.NFT721AccessTemplate.md#extragen) -- [findSigner](templates.NFT721AccessTemplate.md#findsigner) -- [getAddress](templates.NFT721AccessTemplate.md#getaddress) -- [getAgreementCreatedEvent](templates.NFT721AccessTemplate.md#getagreementcreatedevent) -- [getAgreementData](templates.NFT721AccessTemplate.md#getagreementdata) -- [getAgreementIdsFromDDO](templates.NFT721AccessTemplate.md#getagreementidsfromddo) -- [getAgreementStatus](templates.NFT721AccessTemplate.md#getagreementstatus) -- [getAgreementsForDID](templates.NFT721AccessTemplate.md#getagreementsfordid) -- [getConditionTypes](templates.NFT721AccessTemplate.md#getconditiontypes) -- [getConditions](templates.NFT721AccessTemplate.md#getconditions) -- [getContract](templates.NFT721AccessTemplate.md#getcontract) -- [getFromAddress](templates.NFT721AccessTemplate.md#getfromaddress) -- [getInputsOfMethod](templates.NFT721AccessTemplate.md#getinputsofmethod) -- [getServiceAgreementTemplate](templates.NFT721AccessTemplate.md#getserviceagreementtemplate) -- [getServiceAgreementTemplateConditionByRef](templates.NFT721AccessTemplate.md#getserviceagreementtemplateconditionbyref) -- [getServiceAgreementTemplateConditions](templates.NFT721AccessTemplate.md#getserviceagreementtemplateconditions) -- [getServiceAgreementTemplateDependencies](templates.NFT721AccessTemplate.md#getserviceagreementtemplatedependencies) -- [getSignatureOfMethod](templates.NFT721AccessTemplate.md#getsignatureofmethod) -- [init](templates.NFT721AccessTemplate.md#init) -- [instanceFromDDO](templates.NFT721AccessTemplate.md#instancefromddo) -- [lockConditionIndex](templates.NFT721AccessTemplate.md#lockconditionindex) -- [lockTokens](templates.NFT721AccessTemplate.md#locktokens) -- [name](templates.NFT721AccessTemplate.md#name) -- [params](templates.NFT721AccessTemplate.md#params) -- [paramsGen](templates.NFT721AccessTemplate.md#paramsgen) -- [paymentData](templates.NFT721AccessTemplate.md#paymentdata) -- [printAgreementStatus](templates.NFT721AccessTemplate.md#printagreementstatus) -- [process](templates.NFT721AccessTemplate.md#process) -- [send](templates.NFT721AccessTemplate.md#send) -- [sendFrom](templates.NFT721AccessTemplate.md#sendfrom) -- [service](templates.NFT721AccessTemplate.md#service) -- [serviceEndpoint](templates.NFT721AccessTemplate.md#serviceendpoint) -- [setInstanceConfig](templates.NFT721AccessTemplate.md#setinstanceconfig) -- [standardContext](templates.NFT721AccessTemplate.md#standardcontext) -- [validateAgreement](templates.NFT721AccessTemplate.md#validateagreement) -- [addressesStatic](templates.NFT721AccessTemplate.md#addressesstatic) -- [findSignerStatic](templates.NFT721AccessTemplate.md#findsignerstatic) -- [getInstance](templates.NFT721AccessTemplate.md#getinstance) -- [setInstanceConfig](templates.NFT721AccessTemplate.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new NFT721AccessTemplate**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[constructor](templates.BaseTemplate.md#constructor) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L75) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contract](templates.BaseTemplate.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contractName](templates.BaseTemplate.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[events](templates.BaseTemplate.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[version](templates.BaseTemplate.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -BaseTemplate.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -BaseTemplate.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -BaseTemplate.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -BaseTemplate.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### accept - -▸ **accept**(`params`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `ValidationParams` | - -#### Returns - -`Promise`<`boolean`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[accept](templates.BaseTemplate.md#accept) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:93](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L93) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addresses](templates.BaseTemplate.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### agreementId - -▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `creator` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[agreementId](templates.BaseTemplate.md#agreementid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[call](templates.BaseTemplate.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[checkExists](templates.BaseTemplate.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### conditions - -▸ **conditions**(): [[`NFT721HolderCondition`](conditions.NFT721HolderCondition.md), [`NFTAccessCondition`](conditions.NFTAccessCondition.md)] - -#### Returns - -[[`NFT721HolderCondition`](conditions.NFT721HolderCondition.md), [`NFTAccessCondition`](conditions.NFTAccessCondition.md)] - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[conditions](templates.BaseTemplate.md#conditions) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:52](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L52) - -___ - -### createAgreement - -▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `extraArgs` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreement](templates.BaseTemplate.md#createagreement) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L99) - -___ - -### createAgreementAndPay - -▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `accessConsumer` | `string` | -| `condIdx` | `number` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `default`[] | -| `receivers` | `string`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementAndPay](templates.BaseTemplate.md#createagreementandpay) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L124) - -___ - -### createAgreementFromDDO - -▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `params?`): `Promise`<`string`\> - -Create a new agreement using the data of a DDO. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementIdSeed` | `string` | - | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `parameters` | `NFT721AccessTemplateParams` | | -| `consumer` | [`Account`](Account.md) | - | -| `from` | [`Account`](Account.md) | - | -| `timeOuts?` | `number`[] | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`string`\> - -true if the call was successful. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementFromDDO](templates.BaseTemplate.md#createagreementfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L225) - -___ - -### createAgreementWithPaymentFromDDO - -▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`, `observer?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `parameters` | `NFT721AccessTemplateParams` | -| `consumer` | [`Account`](Account.md) | -| `from` | [`Account`](Account.md) | -| `timeOuts?` | `number`[] | -| `txParams?` | `TxParameters` | -| `observer?` | (`OrderProgressStep`: `any`) => `void` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementWithPaymentFromDDO](templates.BaseTemplate.md#createagreementwithpaymentfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L255) - -___ - -### createService - -▸ **createService**(`publisher`, `metadata`, `assetRewards?`, `erc20TokenAddress?`, `priced?`): `Promise`<`ServiceNFTAccess`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `publisher` | [`Account`](Account.md) | `undefined` | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | -| `assetRewards?` | `default` | `undefined` | -| `erc20TokenAddress?` | `string` | `undefined` | -| `priced` | `boolean` | `false` | - -#### Returns - -`Promise`<`ServiceNFTAccess`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createService](templates.BaseTemplate.md#createservice) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L65) - -___ - -### description - -▸ **description**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[description](templates.BaseTemplate.md#description) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L37) - -___ - -### extraGen - -▸ **extraGen**(`_params`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[extraGen](templates.BaseTemplate.md#extragen) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSigner](templates.BaseTemplate.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAddress](templates.BaseTemplate.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getAgreementCreatedEvent - -▸ **getAgreementCreatedEvent**(`agreementId`): `Promise`<`any`[]\> - -Generates and returns the agreement creation event. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`any`[]\> - -Agreement created event. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementCreatedEvent](templates.BaseTemplate.md#getagreementcreatedevent) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L469) - -___ - -### getAgreementData - -▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementData](templates.BaseTemplate.md#getagreementdata) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) - -___ - -### getAgreementIdsFromDDO - -▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> - -Get agreement conditions IDs. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `NFT721AccessTemplateParams` | - | - -#### Returns - -`Promise`<`string`[]\> - -The condition IDs. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementIdsFromDDO](templates.BaseTemplate.md#getagreementidsfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L183) - -___ - -### getAgreementStatus - -▸ **getAgreementStatus**(`agreementId`): `Promise`<``false`` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -Returns the status of the conditions. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<``false`` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -The conditions status. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementStatus](templates.BaseTemplate.md#getagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L343) - -___ - -### getAgreementsForDID - -▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementsForDID](templates.BaseTemplate.md#getagreementsfordid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L496) - -___ - -### getConditionTypes - -▸ **getConditionTypes**(): `Promise`<`string`[]\> - -Conditions address list. - -#### Returns - -`Promise`<`string`[]\> - -A list of condition addresses. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditionTypes](templates.BaseTemplate.md#getconditiontypes) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L163) - -___ - -### getConditions - -▸ **getConditions**(): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -List of condition contracts. - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -A list of condition contracts. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditions](templates.BaseTemplate.md#getconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L171) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getContract](templates.BaseTemplate.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getFromAddress](templates.BaseTemplate.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getInputsOfMethod](templates.BaseTemplate.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getServiceAgreementTemplate - -▸ **getServiceAgreementTemplate**(): `Promise`<`ServiceAgreementTemplate`\> - -#### Returns - -`Promise`<`ServiceAgreementTemplate`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplate](templates.BaseTemplate.md#getserviceagreementtemplate) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:89](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L89) - -___ - -### getServiceAgreementTemplateConditionByRef - -▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ref` | `string` | - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](templates.BaseTemplate.md#getserviceagreementtemplateconditionbyref) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) - -___ - -### getServiceAgreementTemplateConditions - -▸ **getServiceAgreementTemplateConditions**(): `Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Returns - -`Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditions](templates.BaseTemplate.md#getserviceagreementtemplateconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L319) - -___ - -### getServiceAgreementTemplateDependencies - -▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Returns - -`Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateDependencies](templates.BaseTemplate.md#getserviceagreementtemplatedependencies) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L333) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getSignatureOfMethod](templates.BaseTemplate.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[init](templates.BaseTemplate.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`NFT721AccessTemplateParams`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `NFT721AccessTemplateParams` | - -#### Returns - -`Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`NFT721AccessTemplateParams`\>\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[instanceFromDDO](templates.BaseTemplate.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:58](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L58) - -___ - -### lockConditionIndex - -▸ **lockConditionIndex**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockConditionIndex](templates.BaseTemplate.md#lockconditionindex) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L81) - -___ - -### lockTokens - -▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`Account`](Account.md) | -| `txParams` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockTokens](templates.BaseTemplate.md#locktokens) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L398) - -___ - -### name - -▸ **name**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[name](templates.BaseTemplate.md#name) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:34](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L34) - -___ - -### params - -▸ **params**(`holderAddress`): `NFT721AccessTemplateParams` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `holderAddress` | `string` | - -#### Returns - -`NFT721AccessTemplateParams` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[params](templates.BaseTemplate.md#params) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:48](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L48) - -___ - -### paramsGen - -▸ **paramsGen**(`__namedParameters`): `Promise`<`NFT721AccessTemplateParams`\> - -Specialize params - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `__namedParameters` | `ValidationParams` | Generic parameters | - -#### Returns - -`Promise`<`NFT721AccessTemplateParams`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[paramsGen](templates.BaseTemplate.md#paramsgen) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:19](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L19) - -___ - -### paymentData - -▸ **paymentData**(`service`): [`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `service` | `ServiceCommon` | - -#### Returns - -[`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[paymentData](templates.BaseTemplate.md#paymentdata) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L85) - -___ - -### printAgreementStatus - -▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> - -Prints the agreement status. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[printAgreementStatus](templates.BaseTemplate.md#printagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L439) - -___ - -### process - -▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `ValidationParams` | -| `from` | [`Account`](Account.md) | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[process](templates.BaseTemplate.md#process) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L116) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[send](templates.BaseTemplate.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[sendFrom](templates.BaseTemplate.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### service - -▸ **service**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[service](templates.BaseTemplate.md#service) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L41) - -___ - -### serviceEndpoint - -▸ **serviceEndpoint**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[serviceEndpoint](templates.BaseTemplate.md#serviceendpoint) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L44) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### standardContext - -▸ **standardContext**(`ddo`, `creator`): [`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | - -#### Returns - -[`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[standardContext](templates.BaseTemplate.md#standardcontext) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L207) - -___ - -### validateAgreement - -▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `NFT721AccessTemplateParams` | -| `from` | [`Account`](Account.md) | -| `extra` | `any` | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[validateAgreement](templates.BaseTemplate.md#validateagreement) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L131) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addressesStatic](templates.BaseTemplate.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSignerStatic](templates.BaseTemplate.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`NFT721AccessTemplate`](templates.NFT721AccessTemplate.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`NFT721AccessTemplate`](templates.NFT721AccessTemplate.md)\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getInstance](templates.BaseTemplate.md#getinstance) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L24) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/templates.NFT721SalesTemplate.md b/docs/nevermined-sdk/api-reference/classes/templates.NFT721SalesTemplate.md deleted file mode 100644 index a943fc990d..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/templates.NFT721SalesTemplate.md +++ /dev/null @@ -1,1562 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [templates](../modules/templates.md) / NFT721SalesTemplate - -# Class: NFT721SalesTemplate - -[templates](../modules/templates.md).NFT721SalesTemplate - -## Hierarchy - -- [`BaseTemplate`](templates.BaseTemplate.md)<`NFT721SalesTemplateParams`, `ServiceNFTSales`\> - - ↳ **`NFT721SalesTemplate`** - -## Table of contents - -### Constructors - -- [constructor](templates.NFT721SalesTemplate.md#constructor) - -### Properties - -- [contract](templates.NFT721SalesTemplate.md#contract) -- [contractName](templates.NFT721SalesTemplate.md#contractname) -- [events](templates.NFT721SalesTemplate.md#events) -- [version](templates.NFT721SalesTemplate.md#version) - -### Accessors - -- [address](templates.NFT721SalesTemplate.md#address) -- [artifactsFolder](templates.NFT721SalesTemplate.md#artifactsfolder) -- [config](templates.NFT721SalesTemplate.md#config) -- [instanceConfig](templates.NFT721SalesTemplate.md#instanceconfig) -- [instantiableConfig](templates.NFT721SalesTemplate.md#instantiableconfig) -- [logger](templates.NFT721SalesTemplate.md#logger) -- [nevermined](templates.NFT721SalesTemplate.md#nevermined) -- [web3](templates.NFT721SalesTemplate.md#web3) - -### Methods - -- [accept](templates.NFT721SalesTemplate.md#accept) -- [addresses](templates.NFT721SalesTemplate.md#addresses) -- [agreementId](templates.NFT721SalesTemplate.md#agreementid) -- [call](templates.NFT721SalesTemplate.md#call) -- [checkExists](templates.NFT721SalesTemplate.md#checkexists) -- [conditions](templates.NFT721SalesTemplate.md#conditions) -- [createAgreement](templates.NFT721SalesTemplate.md#createagreement) -- [createAgreementAndPay](templates.NFT721SalesTemplate.md#createagreementandpay) -- [createAgreementFromDDO](templates.NFT721SalesTemplate.md#createagreementfromddo) -- [createAgreementWithPaymentFromDDO](templates.NFT721SalesTemplate.md#createagreementwithpaymentfromddo) -- [createService](templates.NFT721SalesTemplate.md#createservice) -- [description](templates.NFT721SalesTemplate.md#description) -- [extraGen](templates.NFT721SalesTemplate.md#extragen) -- [findSigner](templates.NFT721SalesTemplate.md#findsigner) -- [getAddress](templates.NFT721SalesTemplate.md#getaddress) -- [getAgreementCreatedEvent](templates.NFT721SalesTemplate.md#getagreementcreatedevent) -- [getAgreementData](templates.NFT721SalesTemplate.md#getagreementdata) -- [getAgreementIdsFromDDO](templates.NFT721SalesTemplate.md#getagreementidsfromddo) -- [getAgreementStatus](templates.NFT721SalesTemplate.md#getagreementstatus) -- [getAgreementsForDID](templates.NFT721SalesTemplate.md#getagreementsfordid) -- [getConditionTypes](templates.NFT721SalesTemplate.md#getconditiontypes) -- [getConditions](templates.NFT721SalesTemplate.md#getconditions) -- [getContract](templates.NFT721SalesTemplate.md#getcontract) -- [getFromAddress](templates.NFT721SalesTemplate.md#getfromaddress) -- [getInputsOfMethod](templates.NFT721SalesTemplate.md#getinputsofmethod) -- [getServiceAgreementTemplate](templates.NFT721SalesTemplate.md#getserviceagreementtemplate) -- [getServiceAgreementTemplateConditionByRef](templates.NFT721SalesTemplate.md#getserviceagreementtemplateconditionbyref) -- [getServiceAgreementTemplateConditions](templates.NFT721SalesTemplate.md#getserviceagreementtemplateconditions) -- [getServiceAgreementTemplateDependencies](templates.NFT721SalesTemplate.md#getserviceagreementtemplatedependencies) -- [getSignatureOfMethod](templates.NFT721SalesTemplate.md#getsignatureofmethod) -- [init](templates.NFT721SalesTemplate.md#init) -- [instanceFromDDO](templates.NFT721SalesTemplate.md#instancefromddo) -- [lockConditionIndex](templates.NFT721SalesTemplate.md#lockconditionindex) -- [lockTokens](templates.NFT721SalesTemplate.md#locktokens) -- [name](templates.NFT721SalesTemplate.md#name) -- [params](templates.NFT721SalesTemplate.md#params) -- [paramsGen](templates.NFT721SalesTemplate.md#paramsgen) -- [paymentData](templates.NFT721SalesTemplate.md#paymentdata) -- [printAgreementStatus](templates.NFT721SalesTemplate.md#printagreementstatus) -- [process](templates.NFT721SalesTemplate.md#process) -- [send](templates.NFT721SalesTemplate.md#send) -- [sendFrom](templates.NFT721SalesTemplate.md#sendfrom) -- [service](templates.NFT721SalesTemplate.md#service) -- [serviceEndpoint](templates.NFT721SalesTemplate.md#serviceendpoint) -- [setInstanceConfig](templates.NFT721SalesTemplate.md#setinstanceconfig) -- [standardContext](templates.NFT721SalesTemplate.md#standardcontext) -- [validateAgreement](templates.NFT721SalesTemplate.md#validateagreement) -- [addressesStatic](templates.NFT721SalesTemplate.md#addressesstatic) -- [findSignerStatic](templates.NFT721SalesTemplate.md#findsignerstatic) -- [getInstance](templates.NFT721SalesTemplate.md#getinstance) -- [setInstanceConfig](templates.NFT721SalesTemplate.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new NFT721SalesTemplate**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[constructor](templates.BaseTemplate.md#constructor) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L75) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contract](templates.BaseTemplate.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contractName](templates.BaseTemplate.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[events](templates.BaseTemplate.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[version](templates.BaseTemplate.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -BaseTemplate.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -BaseTemplate.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -BaseTemplate.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -BaseTemplate.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### accept - -▸ **accept**(`_params`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[accept](templates.BaseTemplate.md#accept) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:112](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L112) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addresses](templates.BaseTemplate.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### agreementId - -▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `creator` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[agreementId](templates.BaseTemplate.md#agreementid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[call](templates.BaseTemplate.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[checkExists](templates.BaseTemplate.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### conditions - -▸ **conditions**(): [[`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`TransferNFT721Condition`](conditions.TransferNFT721Condition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Returns - -[[`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`TransferNFT721Condition`](conditions.TransferNFT721Condition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[conditions](templates.BaseTemplate.md#conditions) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:61](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L61) - -___ - -### createAgreement - -▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `extraArgs` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreement](templates.BaseTemplate.md#createagreement) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L99) - -___ - -### createAgreementAndPay - -▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `accessConsumer` | `string` | -| `condIdx` | `number` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `default`[] | -| `receivers` | `string`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementAndPay](templates.BaseTemplate.md#createagreementandpay) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L124) - -___ - -### createAgreementFromDDO - -▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `params?`): `Promise`<`string`\> - -Create a new agreement using the data of a DDO. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementIdSeed` | `string` | - | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `parameters` | `NFT721SalesTemplateParams` | | -| `consumer` | [`Account`](Account.md) | - | -| `from` | [`Account`](Account.md) | - | -| `timeOuts?` | `number`[] | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`string`\> - -true if the call was successful. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementFromDDO](templates.BaseTemplate.md#createagreementfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L225) - -___ - -### createAgreementWithPaymentFromDDO - -▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`, `observer?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `parameters` | `NFT721SalesTemplateParams` | -| `consumer` | [`Account`](Account.md) | -| `from` | [`Account`](Account.md) | -| `timeOuts?` | `number`[] | -| `txParams?` | `TxParameters` | -| `observer?` | (`OrderProgressStep`: `any`) => `void` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementWithPaymentFromDDO](templates.BaseTemplate.md#createagreementwithpaymentfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L255) - -___ - -### createService - -▸ **createService**(`publisher`, `metadata`, `assetRewards?`, `erc20TokenAddress?`, `priced?`): `Promise`<`ServiceNFTSales`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `publisher` | [`Account`](Account.md) | `undefined` | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | -| `assetRewards?` | `default` | `undefined` | -| `erc20TokenAddress?` | `string` | `undefined` | -| `priced` | `boolean` | `false` | - -#### Returns - -`Promise`<`ServiceNFTSales`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createService](templates.BaseTemplate.md#createservice) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L65) - -___ - -### description - -▸ **description**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[description](templates.BaseTemplate.md#description) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L44) - -___ - -### extraGen - -▸ **extraGen**(`_params`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[extraGen](templates.BaseTemplate.md#extragen) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSigner](templates.BaseTemplate.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAddress](templates.BaseTemplate.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getAgreementCreatedEvent - -▸ **getAgreementCreatedEvent**(`agreementId`): `Promise`<`any`[]\> - -Generates and returns the agreement creation event. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`any`[]\> - -Agreement created event. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementCreatedEvent](templates.BaseTemplate.md#getagreementcreatedevent) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L469) - -___ - -### getAgreementData - -▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementData](templates.BaseTemplate.md#getagreementdata) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) - -___ - -### getAgreementIdsFromDDO - -▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> - -Get agreement conditions IDs. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `NFT721SalesTemplateParams` | - | - -#### Returns - -`Promise`<`string`[]\> - -The condition IDs. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementIdsFromDDO](templates.BaseTemplate.md#getagreementidsfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L183) - -___ - -### getAgreementStatus - -▸ **getAgreementStatus**(`agreementId`): `Promise`<``false`` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -Returns the status of the conditions. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<``false`` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -The conditions status. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementStatus](templates.BaseTemplate.md#getagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L343) - -___ - -### getAgreementsForDID - -▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementsForDID](templates.BaseTemplate.md#getagreementsfordid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L496) - -___ - -### getConditionTypes - -▸ **getConditionTypes**(): `Promise`<`string`[]\> - -Conditions address list. - -#### Returns - -`Promise`<`string`[]\> - -A list of condition addresses. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditionTypes](templates.BaseTemplate.md#getconditiontypes) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L163) - -___ - -### getConditions - -▸ **getConditions**(): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -List of condition contracts. - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -A list of condition contracts. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditions](templates.BaseTemplate.md#getconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L171) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getContract](templates.BaseTemplate.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getFromAddress](templates.BaseTemplate.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getInputsOfMethod](templates.BaseTemplate.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getServiceAgreementTemplate - -▸ **getServiceAgreementTemplate**(): `Promise`<`ServiceAgreementTemplate`\> - -#### Returns - -`Promise`<`ServiceAgreementTemplate`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplate](templates.BaseTemplate.md#getserviceagreementtemplate) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:114](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L114) - -___ - -### getServiceAgreementTemplateConditionByRef - -▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ref` | `string` | - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](templates.BaseTemplate.md#getserviceagreementtemplateconditionbyref) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) - -___ - -### getServiceAgreementTemplateConditions - -▸ **getServiceAgreementTemplateConditions**(): `Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Returns - -`Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditions](templates.BaseTemplate.md#getserviceagreementtemplateconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L319) - -___ - -### getServiceAgreementTemplateDependencies - -▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Returns - -`Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateDependencies](templates.BaseTemplate.md#getserviceagreementtemplatedependencies) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L333) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getSignatureOfMethod](templates.BaseTemplate.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[init](templates.BaseTemplate.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`NFT721SalesTemplateParams`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `NFT721SalesTemplateParams` | - -#### Returns - -`Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`NFT721SalesTemplateParams`\>\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[instanceFromDDO](templates.BaseTemplate.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:71](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L71) - -___ - -### lockConditionIndex - -▸ **lockConditionIndex**(): `number` - -#### Returns - -`number` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[lockConditionIndex](templates.BaseTemplate.md#lockconditionindex) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:57](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L57) - -___ - -### lockTokens - -▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`Account`](Account.md) | -| `txParams` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockTokens](templates.BaseTemplate.md#locktokens) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L398) - -___ - -### name - -▸ **name**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[name](templates.BaseTemplate.md#name) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L41) - -___ - -### params - -▸ **params**(`consumerId`, `expiration?`): `NFT721SalesTemplateParams` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `consumerId` | `string` | `undefined` | -| `expiration` | `number` | `0` | - -#### Returns - -`NFT721SalesTemplateParams` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[params](templates.BaseTemplate.md#params) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:48](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L48) - -___ - -### paramsGen - -▸ **paramsGen**(`__namedParameters`): `Promise`<`NFT721SalesTemplateParams`\> - -Specialize params - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `__namedParameters` | `ValidationParams` | Generic parameters | - -#### Returns - -`Promise`<`NFT721SalesTemplateParams`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[paramsGen](templates.BaseTemplate.md#paramsgen) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:51](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L51) - -___ - -### paymentData - -▸ **paymentData**(`service`): [`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `service` | `ServiceCommon` | - -#### Returns - -[`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[paymentData](templates.BaseTemplate.md#paymentdata) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L85) - -___ - -### printAgreementStatus - -▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> - -Prints the agreement status. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[printAgreementStatus](templates.BaseTemplate.md#printagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L439) - -___ - -### process - -▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `ValidationParams` | -| `from` | [`Account`](Account.md) | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[process](templates.BaseTemplate.md#process) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L116) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[send](templates.BaseTemplate.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[sendFrom](templates.BaseTemplate.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### service - -▸ **service**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[service](templates.BaseTemplate.md#service) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:34](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L34) - -___ - -### serviceEndpoint - -▸ **serviceEndpoint**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[serviceEndpoint](templates.BaseTemplate.md#serviceendpoint) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L37) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### standardContext - -▸ **standardContext**(`ddo`, `creator`): [`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | - -#### Returns - -[`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[standardContext](templates.BaseTemplate.md#standardcontext) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L207) - -___ - -### validateAgreement - -▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `NFT721SalesTemplateParams` | -| `from` | [`Account`](Account.md) | -| `extra` | `any` | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[validateAgreement](templates.BaseTemplate.md#validateagreement) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L131) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addressesStatic](templates.BaseTemplate.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSignerStatic](templates.BaseTemplate.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`NFT721SalesTemplate`](templates.NFT721SalesTemplate.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`NFT721SalesTemplate`](templates.NFT721SalesTemplate.md)\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getInstance](templates.BaseTemplate.md#getinstance) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L23) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/templates.NFTAccessTemplate.md b/docs/nevermined-sdk/api-reference/classes/templates.NFTAccessTemplate.md deleted file mode 100644 index b2470f4c3f..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/templates.NFTAccessTemplate.md +++ /dev/null @@ -1,1562 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [templates](../modules/templates.md) / NFTAccessTemplate - -# Class: NFTAccessTemplate - -[templates](../modules/templates.md).NFTAccessTemplate - -## Hierarchy - -- [`BaseTemplate`](templates.BaseTemplate.md)<`NFTAccessTemplateParams`, `ServiceNFTAccess`\> - - ↳ **`NFTAccessTemplate`** - -## Table of contents - -### Constructors - -- [constructor](templates.NFTAccessTemplate.md#constructor) - -### Properties - -- [contract](templates.NFTAccessTemplate.md#contract) -- [contractName](templates.NFTAccessTemplate.md#contractname) -- [events](templates.NFTAccessTemplate.md#events) -- [version](templates.NFTAccessTemplate.md#version) - -### Accessors - -- [address](templates.NFTAccessTemplate.md#address) -- [artifactsFolder](templates.NFTAccessTemplate.md#artifactsfolder) -- [config](templates.NFTAccessTemplate.md#config) -- [instanceConfig](templates.NFTAccessTemplate.md#instanceconfig) -- [instantiableConfig](templates.NFTAccessTemplate.md#instantiableconfig) -- [logger](templates.NFTAccessTemplate.md#logger) -- [nevermined](templates.NFTAccessTemplate.md#nevermined) -- [web3](templates.NFTAccessTemplate.md#web3) - -### Methods - -- [accept](templates.NFTAccessTemplate.md#accept) -- [addresses](templates.NFTAccessTemplate.md#addresses) -- [agreementId](templates.NFTAccessTemplate.md#agreementid) -- [call](templates.NFTAccessTemplate.md#call) -- [checkExists](templates.NFTAccessTemplate.md#checkexists) -- [conditions](templates.NFTAccessTemplate.md#conditions) -- [createAgreement](templates.NFTAccessTemplate.md#createagreement) -- [createAgreementAndPay](templates.NFTAccessTemplate.md#createagreementandpay) -- [createAgreementFromDDO](templates.NFTAccessTemplate.md#createagreementfromddo) -- [createAgreementWithPaymentFromDDO](templates.NFTAccessTemplate.md#createagreementwithpaymentfromddo) -- [createService](templates.NFTAccessTemplate.md#createservice) -- [description](templates.NFTAccessTemplate.md#description) -- [extraGen](templates.NFTAccessTemplate.md#extragen) -- [findSigner](templates.NFTAccessTemplate.md#findsigner) -- [getAddress](templates.NFTAccessTemplate.md#getaddress) -- [getAgreementCreatedEvent](templates.NFTAccessTemplate.md#getagreementcreatedevent) -- [getAgreementData](templates.NFTAccessTemplate.md#getagreementdata) -- [getAgreementIdsFromDDO](templates.NFTAccessTemplate.md#getagreementidsfromddo) -- [getAgreementStatus](templates.NFTAccessTemplate.md#getagreementstatus) -- [getAgreementsForDID](templates.NFTAccessTemplate.md#getagreementsfordid) -- [getConditionTypes](templates.NFTAccessTemplate.md#getconditiontypes) -- [getConditions](templates.NFTAccessTemplate.md#getconditions) -- [getContract](templates.NFTAccessTemplate.md#getcontract) -- [getFromAddress](templates.NFTAccessTemplate.md#getfromaddress) -- [getInputsOfMethod](templates.NFTAccessTemplate.md#getinputsofmethod) -- [getServiceAgreementTemplate](templates.NFTAccessTemplate.md#getserviceagreementtemplate) -- [getServiceAgreementTemplateConditionByRef](templates.NFTAccessTemplate.md#getserviceagreementtemplateconditionbyref) -- [getServiceAgreementTemplateConditions](templates.NFTAccessTemplate.md#getserviceagreementtemplateconditions) -- [getServiceAgreementTemplateDependencies](templates.NFTAccessTemplate.md#getserviceagreementtemplatedependencies) -- [getSignatureOfMethod](templates.NFTAccessTemplate.md#getsignatureofmethod) -- [init](templates.NFTAccessTemplate.md#init) -- [instanceFromDDO](templates.NFTAccessTemplate.md#instancefromddo) -- [lockConditionIndex](templates.NFTAccessTemplate.md#lockconditionindex) -- [lockTokens](templates.NFTAccessTemplate.md#locktokens) -- [name](templates.NFTAccessTemplate.md#name) -- [params](templates.NFTAccessTemplate.md#params) -- [paramsGen](templates.NFTAccessTemplate.md#paramsgen) -- [paymentData](templates.NFTAccessTemplate.md#paymentdata) -- [printAgreementStatus](templates.NFTAccessTemplate.md#printagreementstatus) -- [process](templates.NFTAccessTemplate.md#process) -- [send](templates.NFTAccessTemplate.md#send) -- [sendFrom](templates.NFTAccessTemplate.md#sendfrom) -- [service](templates.NFTAccessTemplate.md#service) -- [serviceEndpoint](templates.NFTAccessTemplate.md#serviceendpoint) -- [setInstanceConfig](templates.NFTAccessTemplate.md#setinstanceconfig) -- [standardContext](templates.NFTAccessTemplate.md#standardcontext) -- [validateAgreement](templates.NFTAccessTemplate.md#validateagreement) -- [addressesStatic](templates.NFTAccessTemplate.md#addressesstatic) -- [findSignerStatic](templates.NFTAccessTemplate.md#findsignerstatic) -- [getInstance](templates.NFTAccessTemplate.md#getinstance) -- [setInstanceConfig](templates.NFTAccessTemplate.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new NFTAccessTemplate**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[constructor](templates.BaseTemplate.md#constructor) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L75) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contract](templates.BaseTemplate.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contractName](templates.BaseTemplate.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[events](templates.BaseTemplate.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[version](templates.BaseTemplate.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -BaseTemplate.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -BaseTemplate.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -BaseTemplate.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -BaseTemplate.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### accept - -▸ **accept**(`params`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `ValidationParams` | - -#### Returns - -`Promise`<`boolean`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[accept](templates.BaseTemplate.md#accept) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:91](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L91) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addresses](templates.BaseTemplate.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### agreementId - -▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `creator` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[agreementId](templates.BaseTemplate.md#agreementid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[call](templates.BaseTemplate.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[checkExists](templates.BaseTemplate.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### conditions - -▸ **conditions**(): [[`NFTHolderCondition`](conditions.NFTHolderCondition.md), [`NFTAccessCondition`](conditions.NFTAccessCondition.md)] - -#### Returns - -[[`NFTHolderCondition`](conditions.NFTHolderCondition.md), [`NFTAccessCondition`](conditions.NFTAccessCondition.md)] - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[conditions](templates.BaseTemplate.md#conditions) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L50) - -___ - -### createAgreement - -▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `extraArgs` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreement](templates.BaseTemplate.md#createagreement) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L99) - -___ - -### createAgreementAndPay - -▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `accessConsumer` | `string` | -| `condIdx` | `number` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `default`[] | -| `receivers` | `string`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementAndPay](templates.BaseTemplate.md#createagreementandpay) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L124) - -___ - -### createAgreementFromDDO - -▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `params?`): `Promise`<`string`\> - -Create a new agreement using the data of a DDO. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementIdSeed` | `string` | - | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `parameters` | `NFTAccessTemplateParams` | | -| `consumer` | [`Account`](Account.md) | - | -| `from` | [`Account`](Account.md) | - | -| `timeOuts?` | `number`[] | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`string`\> - -true if the call was successful. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementFromDDO](templates.BaseTemplate.md#createagreementfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L225) - -___ - -### createAgreementWithPaymentFromDDO - -▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`, `observer?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `parameters` | `NFTAccessTemplateParams` | -| `consumer` | [`Account`](Account.md) | -| `from` | [`Account`](Account.md) | -| `timeOuts?` | `number`[] | -| `txParams?` | `TxParameters` | -| `observer?` | (`OrderProgressStep`: `any`) => `void` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementWithPaymentFromDDO](templates.BaseTemplate.md#createagreementwithpaymentfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L255) - -___ - -### createService - -▸ **createService**(`publisher`, `metadata`, `assetRewards?`, `erc20TokenAddress?`, `priced?`): `Promise`<`ServiceNFTAccess`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `publisher` | [`Account`](Account.md) | `undefined` | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | -| `assetRewards?` | `default` | `undefined` | -| `erc20TokenAddress?` | `string` | `undefined` | -| `priced` | `boolean` | `false` | - -#### Returns - -`Promise`<`ServiceNFTAccess`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createService](templates.BaseTemplate.md#createservice) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L65) - -___ - -### description - -▸ **description**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[description](templates.BaseTemplate.md#description) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L37) - -___ - -### extraGen - -▸ **extraGen**(`_params`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[extraGen](templates.BaseTemplate.md#extragen) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSigner](templates.BaseTemplate.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAddress](templates.BaseTemplate.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getAgreementCreatedEvent - -▸ **getAgreementCreatedEvent**(`agreementId`): `Promise`<`any`[]\> - -Generates and returns the agreement creation event. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`any`[]\> - -Agreement created event. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementCreatedEvent](templates.BaseTemplate.md#getagreementcreatedevent) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L469) - -___ - -### getAgreementData - -▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementData](templates.BaseTemplate.md#getagreementdata) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) - -___ - -### getAgreementIdsFromDDO - -▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> - -Get agreement conditions IDs. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `NFTAccessTemplateParams` | - | - -#### Returns - -`Promise`<`string`[]\> - -The condition IDs. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementIdsFromDDO](templates.BaseTemplate.md#getagreementidsfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L183) - -___ - -### getAgreementStatus - -▸ **getAgreementStatus**(`agreementId`): `Promise`<``false`` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -Returns the status of the conditions. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<``false`` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -The conditions status. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementStatus](templates.BaseTemplate.md#getagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L343) - -___ - -### getAgreementsForDID - -▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementsForDID](templates.BaseTemplate.md#getagreementsfordid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L496) - -___ - -### getConditionTypes - -▸ **getConditionTypes**(): `Promise`<`string`[]\> - -Conditions address list. - -#### Returns - -`Promise`<`string`[]\> - -A list of condition addresses. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditionTypes](templates.BaseTemplate.md#getconditiontypes) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L163) - -___ - -### getConditions - -▸ **getConditions**(): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -List of condition contracts. - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -A list of condition contracts. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditions](templates.BaseTemplate.md#getconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L171) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getContract](templates.BaseTemplate.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getFromAddress](templates.BaseTemplate.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getInputsOfMethod](templates.BaseTemplate.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getServiceAgreementTemplate - -▸ **getServiceAgreementTemplate**(): `Promise`<`ServiceAgreementTemplate`\> - -#### Returns - -`Promise`<`ServiceAgreementTemplate`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplate](templates.BaseTemplate.md#getserviceagreementtemplate) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L87) - -___ - -### getServiceAgreementTemplateConditionByRef - -▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ref` | `string` | - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](templates.BaseTemplate.md#getserviceagreementtemplateconditionbyref) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) - -___ - -### getServiceAgreementTemplateConditions - -▸ **getServiceAgreementTemplateConditions**(): `Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Returns - -`Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditions](templates.BaseTemplate.md#getserviceagreementtemplateconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L319) - -___ - -### getServiceAgreementTemplateDependencies - -▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Returns - -`Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateDependencies](templates.BaseTemplate.md#getserviceagreementtemplatedependencies) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L333) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getSignatureOfMethod](templates.BaseTemplate.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[init](templates.BaseTemplate.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`NFTAccessTemplateParams`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `NFTAccessTemplateParams` | - -#### Returns - -`Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`NFTAccessTemplateParams`\>\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[instanceFromDDO](templates.BaseTemplate.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:56](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L56) - -___ - -### lockConditionIndex - -▸ **lockConditionIndex**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockConditionIndex](templates.BaseTemplate.md#lockconditionindex) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L81) - -___ - -### lockTokens - -▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`Account`](Account.md) | -| `txParams` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockTokens](templates.BaseTemplate.md#locktokens) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L398) - -___ - -### name - -▸ **name**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[name](templates.BaseTemplate.md#name) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:34](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L34) - -___ - -### params - -▸ **params**(`holderAddress`, `amount?`): `NFTAccessTemplateParams` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `holderAddress` | `string` | -| `amount?` | `default` | - -#### Returns - -`NFTAccessTemplateParams` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[params](templates.BaseTemplate.md#params) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L41) - -___ - -### paramsGen - -▸ **paramsGen**(`__namedParameters`): `Promise`<`NFTAccessTemplateParams`\> - -Specialize params - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `__namedParameters` | `ValidationParams` | Generic parameters | - -#### Returns - -`Promise`<`NFTAccessTemplateParams`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[paramsGen](templates.BaseTemplate.md#paramsgen) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L44) - -___ - -### paymentData - -▸ **paymentData**(`service`): [`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `service` | `ServiceCommon` | - -#### Returns - -[`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[paymentData](templates.BaseTemplate.md#paymentdata) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L85) - -___ - -### printAgreementStatus - -▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> - -Prints the agreement status. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[printAgreementStatus](templates.BaseTemplate.md#printagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L439) - -___ - -### process - -▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `ValidationParams` | -| `from` | [`Account`](Account.md) | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[process](templates.BaseTemplate.md#process) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L116) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[send](templates.BaseTemplate.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[sendFrom](templates.BaseTemplate.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### service - -▸ **service**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[service](templates.BaseTemplate.md#service) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L31) - -___ - -### serviceEndpoint - -▸ **serviceEndpoint**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[serviceEndpoint](templates.BaseTemplate.md#serviceendpoint) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### standardContext - -▸ **standardContext**(`ddo`, `creator`): [`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | - -#### Returns - -[`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[standardContext](templates.BaseTemplate.md#standardcontext) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L207) - -___ - -### validateAgreement - -▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `NFTAccessTemplateParams` | -| `from` | [`Account`](Account.md) | -| `extra` | `any` | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[validateAgreement](templates.BaseTemplate.md#validateagreement) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L131) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addressesStatic](templates.BaseTemplate.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSignerStatic](templates.BaseTemplate.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`NFTAccessTemplate`](templates.NFTAccessTemplate.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`NFTAccessTemplate`](templates.NFTAccessTemplate.md)\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getInstance](templates.BaseTemplate.md#getinstance) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L21) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/templates.NFTSalesTemplate.md b/docs/nevermined-sdk/api-reference/classes/templates.NFTSalesTemplate.md deleted file mode 100644 index 5a710892eb..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/templates.NFTSalesTemplate.md +++ /dev/null @@ -1,1563 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [templates](../modules/templates.md) / NFTSalesTemplate - -# Class: NFTSalesTemplate - -[templates](../modules/templates.md).NFTSalesTemplate - -## Hierarchy - -- [`BaseTemplate`](templates.BaseTemplate.md)<`NFTSalesTemplateParams`, `ServiceNFTSales`\> - - ↳ **`NFTSalesTemplate`** - -## Table of contents - -### Constructors - -- [constructor](templates.NFTSalesTemplate.md#constructor) - -### Properties - -- [contract](templates.NFTSalesTemplate.md#contract) -- [contractName](templates.NFTSalesTemplate.md#contractname) -- [events](templates.NFTSalesTemplate.md#events) -- [version](templates.NFTSalesTemplate.md#version) - -### Accessors - -- [address](templates.NFTSalesTemplate.md#address) -- [artifactsFolder](templates.NFTSalesTemplate.md#artifactsfolder) -- [config](templates.NFTSalesTemplate.md#config) -- [instanceConfig](templates.NFTSalesTemplate.md#instanceconfig) -- [instantiableConfig](templates.NFTSalesTemplate.md#instantiableconfig) -- [logger](templates.NFTSalesTemplate.md#logger) -- [nevermined](templates.NFTSalesTemplate.md#nevermined) -- [web3](templates.NFTSalesTemplate.md#web3) - -### Methods - -- [accept](templates.NFTSalesTemplate.md#accept) -- [addresses](templates.NFTSalesTemplate.md#addresses) -- [agreementId](templates.NFTSalesTemplate.md#agreementid) -- [call](templates.NFTSalesTemplate.md#call) -- [checkExists](templates.NFTSalesTemplate.md#checkexists) -- [conditions](templates.NFTSalesTemplate.md#conditions) -- [createAgreement](templates.NFTSalesTemplate.md#createagreement) -- [createAgreementAndPay](templates.NFTSalesTemplate.md#createagreementandpay) -- [createAgreementFromDDO](templates.NFTSalesTemplate.md#createagreementfromddo) -- [createAgreementWithPaymentFromDDO](templates.NFTSalesTemplate.md#createagreementwithpaymentfromddo) -- [createService](templates.NFTSalesTemplate.md#createservice) -- [description](templates.NFTSalesTemplate.md#description) -- [extraGen](templates.NFTSalesTemplate.md#extragen) -- [findSigner](templates.NFTSalesTemplate.md#findsigner) -- [getAddress](templates.NFTSalesTemplate.md#getaddress) -- [getAgreementCreatedEvent](templates.NFTSalesTemplate.md#getagreementcreatedevent) -- [getAgreementData](templates.NFTSalesTemplate.md#getagreementdata) -- [getAgreementIdsFromDDO](templates.NFTSalesTemplate.md#getagreementidsfromddo) -- [getAgreementStatus](templates.NFTSalesTemplate.md#getagreementstatus) -- [getAgreementsForDID](templates.NFTSalesTemplate.md#getagreementsfordid) -- [getConditionTypes](templates.NFTSalesTemplate.md#getconditiontypes) -- [getConditions](templates.NFTSalesTemplate.md#getconditions) -- [getContract](templates.NFTSalesTemplate.md#getcontract) -- [getFromAddress](templates.NFTSalesTemplate.md#getfromaddress) -- [getInputsOfMethod](templates.NFTSalesTemplate.md#getinputsofmethod) -- [getServiceAgreementTemplate](templates.NFTSalesTemplate.md#getserviceagreementtemplate) -- [getServiceAgreementTemplateConditionByRef](templates.NFTSalesTemplate.md#getserviceagreementtemplateconditionbyref) -- [getServiceAgreementTemplateConditions](templates.NFTSalesTemplate.md#getserviceagreementtemplateconditions) -- [getServiceAgreementTemplateDependencies](templates.NFTSalesTemplate.md#getserviceagreementtemplatedependencies) -- [getSignatureOfMethod](templates.NFTSalesTemplate.md#getsignatureofmethod) -- [init](templates.NFTSalesTemplate.md#init) -- [instanceFromDDO](templates.NFTSalesTemplate.md#instancefromddo) -- [lockConditionIndex](templates.NFTSalesTemplate.md#lockconditionindex) -- [lockTokens](templates.NFTSalesTemplate.md#locktokens) -- [name](templates.NFTSalesTemplate.md#name) -- [params](templates.NFTSalesTemplate.md#params) -- [paramsGen](templates.NFTSalesTemplate.md#paramsgen) -- [paymentData](templates.NFTSalesTemplate.md#paymentdata) -- [printAgreementStatus](templates.NFTSalesTemplate.md#printagreementstatus) -- [process](templates.NFTSalesTemplate.md#process) -- [send](templates.NFTSalesTemplate.md#send) -- [sendFrom](templates.NFTSalesTemplate.md#sendfrom) -- [service](templates.NFTSalesTemplate.md#service) -- [serviceEndpoint](templates.NFTSalesTemplate.md#serviceendpoint) -- [setInstanceConfig](templates.NFTSalesTemplate.md#setinstanceconfig) -- [standardContext](templates.NFTSalesTemplate.md#standardcontext) -- [validateAgreement](templates.NFTSalesTemplate.md#validateagreement) -- [addressesStatic](templates.NFTSalesTemplate.md#addressesstatic) -- [findSignerStatic](templates.NFTSalesTemplate.md#findsignerstatic) -- [getInstance](templates.NFTSalesTemplate.md#getinstance) -- [setInstanceConfig](templates.NFTSalesTemplate.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new NFTSalesTemplate**(`contractName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractName` | `string` | - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[constructor](templates.BaseTemplate.md#constructor) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L75) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contract](templates.BaseTemplate.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - -___ - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contractName](templates.BaseTemplate.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - -___ - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[events](templates.BaseTemplate.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - -___ - -### version - -• **version**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[version](templates.BaseTemplate.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - -___ - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - -___ - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -BaseTemplate.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - -___ - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - -___ - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - -___ - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -BaseTemplate.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - -___ - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -BaseTemplate.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - -___ - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -BaseTemplate.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### accept - -▸ **accept**(`_params`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[accept](templates.BaseTemplate.md#accept) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:112](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L112) - -___ - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addresses](templates.BaseTemplate.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - -___ - -### agreementId - -▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `creator` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[agreementId](templates.BaseTemplate.md#agreementid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) - -___ - -### call - -▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | `string` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[call](templates.BaseTemplate.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - -___ - -### checkExists - -▸ `Protected` **checkExists**(`address`): `Promise`<`boolean`\> - -Returns true of contract exists else it throws. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -true if the contract exists. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[checkExists](templates.BaseTemplate.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - -___ - -### conditions - -▸ **conditions**(): [[`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`TransferNFTCondition`](conditions.TransferNFTCondition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Returns - -[[`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`TransferNFTCondition`](conditions.TransferNFTCondition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[conditions](templates.BaseTemplate.md#conditions) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:61](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L61) - -___ - -### createAgreement - -▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `extraArgs` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreement](templates.BaseTemplate.md#createagreement) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L99) - -___ - -### createAgreementAndPay - -▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `accessConsumer` | `string` | -| `condIdx` | `number` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `default`[] | -| `receivers` | `string`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementAndPay](templates.BaseTemplate.md#createagreementandpay) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L124) - -___ - -### createAgreementFromDDO - -▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `params?`): `Promise`<`string`\> - -Create a new agreement using the data of a DDO. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementIdSeed` | `string` | - | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `parameters` | `NFTSalesTemplateParams` | | -| `consumer` | [`Account`](Account.md) | - | -| `from` | [`Account`](Account.md) | - | -| `timeOuts?` | `number`[] | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`string`\> - -true if the call was successful. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementFromDDO](templates.BaseTemplate.md#createagreementfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L225) - -___ - -### createAgreementWithPaymentFromDDO - -▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`, `observer?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `parameters` | `NFTSalesTemplateParams` | -| `consumer` | [`Account`](Account.md) | -| `from` | [`Account`](Account.md) | -| `timeOuts?` | `number`[] | -| `txParams?` | `TxParameters` | -| `observer?` | (`OrderProgressStep`: `any`) => `void` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementWithPaymentFromDDO](templates.BaseTemplate.md#createagreementwithpaymentfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L255) - -___ - -### createService - -▸ **createService**(`publisher`, `metadata`, `assetRewards?`, `erc20TokenAddress?`, `priced?`): `Promise`<`ServiceNFTSales`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `publisher` | [`Account`](Account.md) | `undefined` | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | -| `assetRewards?` | `default` | `undefined` | -| `erc20TokenAddress?` | `string` | `undefined` | -| `priced` | `boolean` | `false` | - -#### Returns - -`Promise`<`ServiceNFTSales`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createService](templates.BaseTemplate.md#createservice) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L65) - -___ - -### description - -▸ **description**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[description](templates.BaseTemplate.md#description) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:38](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L38) - -___ - -### extraGen - -▸ **extraGen**(`_params`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[extraGen](templates.BaseTemplate.md#extragen) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) - -___ - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSigner](templates.BaseTemplate.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - -___ - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAddress](templates.BaseTemplate.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - -___ - -### getAgreementCreatedEvent - -▸ **getAgreementCreatedEvent**(`agreementId`): `Promise`<`any`[]\> - -Generates and returns the agreement creation event. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`any`[]\> - -Agreement created event. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementCreatedEvent](templates.BaseTemplate.md#getagreementcreatedevent) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L469) - -___ - -### getAgreementData - -▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementId` | `string` | - -#### Returns - -`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementData](templates.BaseTemplate.md#getagreementdata) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) - -___ - -### getAgreementIdsFromDDO - -▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> - -Get agreement conditions IDs. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `NFTSalesTemplateParams` | - | - -#### Returns - -`Promise`<`string`[]\> - -The condition IDs. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementIdsFromDDO](templates.BaseTemplate.md#getagreementidsfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L183) - -___ - -### getAgreementStatus - -▸ **getAgreementStatus**(`agreementId`): `Promise`<``false`` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -Returns the status of the conditions. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<``false`` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -The conditions status. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementStatus](templates.BaseTemplate.md#getagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L343) - -___ - -### getAgreementsForDID - -▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementsForDID](templates.BaseTemplate.md#getagreementsfordid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L496) - -___ - -### getConditionTypes - -▸ **getConditionTypes**(): `Promise`<`string`[]\> - -Conditions address list. - -#### Returns - -`Promise`<`string`[]\> - -A list of condition addresses. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditionTypes](templates.BaseTemplate.md#getconditiontypes) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L163) - -___ - -### getConditions - -▸ **getConditions**(): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -List of condition contracts. - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -A list of condition contracts. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditions](templates.BaseTemplate.md#getconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L171) - -___ - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getContract](templates.BaseTemplate.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - -___ - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getFromAddress](templates.BaseTemplate.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - -___ - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getInputsOfMethod](templates.BaseTemplate.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - -___ - -### getServiceAgreementTemplate - -▸ **getServiceAgreementTemplate**(): `Promise`<`ServiceAgreementTemplate`\> - -#### Returns - -`Promise`<`ServiceAgreementTemplate`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplate](templates.BaseTemplate.md#getserviceagreementtemplate) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:114](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L114) - -___ - -### getServiceAgreementTemplateConditionByRef - -▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ref` | `string` | - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](templates.BaseTemplate.md#getserviceagreementtemplateconditionbyref) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) - -___ - -### getServiceAgreementTemplateConditions - -▸ **getServiceAgreementTemplateConditions**(): `Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Returns - -`Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditions](templates.BaseTemplate.md#getserviceagreementtemplateconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L319) - -___ - -### getServiceAgreementTemplateDependencies - -▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Returns - -`Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateDependencies](templates.BaseTemplate.md#getserviceagreementtemplatedependencies) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L333) - -___ - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getSignatureOfMethod](templates.BaseTemplate.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - -___ - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[init](templates.BaseTemplate.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - -___ - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`NFTSalesTemplateParams`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `NFTSalesTemplateParams` | - -#### Returns - -`Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`NFTSalesTemplateParams`\>\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[instanceFromDDO](templates.BaseTemplate.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:71](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L71) - -___ - -### lockConditionIndex - -▸ **lockConditionIndex**(): `number` - -#### Returns - -`number` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[lockConditionIndex](templates.BaseTemplate.md#lockconditionindex) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:57](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L57) - -___ - -### lockTokens - -▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`Account`](Account.md) | -| `txParams` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockTokens](templates.BaseTemplate.md#locktokens) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L398) - -___ - -### name - -▸ **name**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[name](templates.BaseTemplate.md#name) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L35) - -___ - -### params - -▸ **params**(`consumerId`, `nftAmount`, `providerId?`): `NFTSalesTemplateParams` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `consumerId` | `string` | -| `nftAmount` | `default` | -| `providerId?` | `string` | - -#### Returns - -`NFTSalesTemplateParams` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[params](templates.BaseTemplate.md#params) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:42](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L42) - -___ - -### paramsGen - -▸ **paramsGen**(`__namedParameters`): `Promise`<`NFTSalesTemplateParams`\> - -Specialize params - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `__namedParameters` | `ValidationParams` | Generic parameters | - -#### Returns - -`Promise`<`NFTSalesTemplateParams`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[paramsGen](templates.BaseTemplate.md#paramsgen) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L50) - -___ - -### paymentData - -▸ **paymentData**(`service`): [`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `service` | `ServiceCommon` | - -#### Returns - -[`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[paymentData](templates.BaseTemplate.md#paymentdata) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L85) - -___ - -### printAgreementStatus - -▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> - -Prints the agreement status. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[printAgreementStatus](templates.BaseTemplate.md#printagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L439) - -___ - -### process - -▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `ValidationParams` | -| `from` | [`Account`](Account.md) | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[process](templates.BaseTemplate.md#process) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L116) - -___ - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[send](templates.BaseTemplate.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - -___ - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[sendFrom](templates.BaseTemplate.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - -___ - -### service - -▸ **service**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[service](templates.BaseTemplate.md#service) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L31) - -___ - -### serviceEndpoint - -▸ **serviceEndpoint**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[serviceEndpoint](templates.BaseTemplate.md#serviceendpoint) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) - -___ - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - -___ - -### standardContext - -▸ **standardContext**(`ddo`, `creator`): [`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | - -#### Returns - -[`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[standardContext](templates.BaseTemplate.md#standardcontext) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L207) - -___ - -### validateAgreement - -▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `NFTSalesTemplateParams` | -| `from` | [`Account`](Account.md) | -| `extra` | `any` | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[validateAgreement](templates.BaseTemplate.md#validateagreement) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L131) - -___ - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addressesStatic](templates.BaseTemplate.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - -___ - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSignerStatic](templates.BaseTemplate.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - -___ - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`NFTSalesTemplate`](templates.NFTSalesTemplate.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`NFTSalesTemplate`](templates.NFTSalesTemplate.md)\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getInstance](templates.BaseTemplate.md#getinstance) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L25) - -___ - -### setInstanceConfig - -▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Instantiable`<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/nevermined-sdk/api-reference/classes/utils.Logger.md b/docs/nevermined-sdk/api-reference/classes/utils.Logger.md deleted file mode 100644 index fa09d429d8..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/utils.Logger.md +++ /dev/null @@ -1,193 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [utils](../modules/utils.md) / Logger - -# Class: Logger - -[utils](../modules/utils.md).Logger - -## Table of contents - -### Constructors - -- [constructor](utils.Logger.md#constructor) - -### Properties - -- [logLevel](utils.Logger.md#loglevel) - -### Methods - -- [bypass](utils.Logger.md#bypass) -- [debug](utils.Logger.md#debug) -- [dispatch](utils.Logger.md#dispatch) -- [error](utils.Logger.md#error) -- [log](utils.Logger.md#log) -- [setLevel](utils.Logger.md#setlevel) -- [warn](utils.Logger.md#warn) - -## Constructors - -### constructor - -• **new Logger**(`logLevel?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `logLevel` | [`LogLevel`](../enums/utils.LogLevel.md) | `LogLevel.Warn` | - -#### Defined in - -[src/utils/Logger.ts:10](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L10) - -## Properties - -### logLevel - -• `Private` **logLevel**: [`LogLevel`](../enums/utils.LogLevel.md) = `LogLevel.Warn` - -#### Defined in - -[src/utils/Logger.ts:10](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L10) - -## Methods - -### bypass - -▸ **bypass**(...`args`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`void` - -#### Defined in - -[src/utils/Logger.ts:16](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L16) - -___ - -### debug - -▸ **debug**(...`args`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`void` - -#### Defined in - -[src/utils/Logger.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L20) - -___ - -### dispatch - -▸ `Private` **dispatch**(`verb`, `level`, ...`args`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `verb` | `string` | -| `level` | [`LogLevel`](../enums/utils.LogLevel.md) | -| `...args` | `any`[] | - -#### Returns - -`void` - -#### Defined in - -[src/utils/Logger.ts:36](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L36) - -___ - -### error - -▸ **error**(...`args`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`void` - -#### Defined in - -[src/utils/Logger.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L32) - -___ - -### log - -▸ **log**(...`args`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`void` - -#### Defined in - -[src/utils/Logger.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L24) - -___ - -### setLevel - -▸ **setLevel**(`logLevel`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `logLevel` | [`LogLevel`](../enums/utils.LogLevel.md) | - -#### Returns - -`void` - -#### Defined in - -[src/utils/Logger.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L12) - -___ - -### warn - -▸ **warn**(...`args`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`void` - -#### Defined in - -[src/utils/Logger.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L28) diff --git a/docs/nevermined-sdk/api-reference/classes/utils.SubscribableObserver.md b/docs/nevermined-sdk/api-reference/classes/utils.SubscribableObserver.md deleted file mode 100644 index 214b3c5e03..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/utils.SubscribableObserver.md +++ /dev/null @@ -1,186 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [utils](../modules/utils.md) / SubscribableObserver - -# Class: SubscribableObserver - -[utils](../modules/utils.md).SubscribableObserver - -## Type parameters - -| Name | -| :------ | -| `T` | -| `P` | - -## Table of contents - -### Constructors - -- [constructor](utils.SubscribableObserver.md#constructor) - -### Properties - -- [completed](utils.SubscribableObserver.md#completed) -- [subscriptions](utils.SubscribableObserver.md#subscriptions) - -### Methods - -- [complete](utils.SubscribableObserver.md#complete) -- [emit](utils.SubscribableObserver.md#emit) -- [error](utils.SubscribableObserver.md#error) -- [next](utils.SubscribableObserver.md#next) -- [subscribe](utils.SubscribableObserver.md#subscribe) -- [unsubscribe](utils.SubscribableObserver.md#unsubscribe) - -## Constructors - -### constructor - -• **new SubscribableObserver**<`T`, `P`\>() - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `P` | - -## Properties - -### completed - -• **completed**: `boolean` = `false` - -#### Defined in - -[src/utils/SubscribableObserver.ts:2](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribableObserver.ts#L2) - -___ - -### subscriptions - -• `Private` **subscriptions**: `Set`<{ `onComplete?`: (`complete`: `P`) => `void` ; `onError?`: (`error`: `any`) => `void` ; `onNext?`: (`next`: `T`) => `void` }\> - -#### Defined in - -[src/utils/SubscribableObserver.ts:4](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribableObserver.ts#L4) - -## Methods - -### complete - -▸ **complete**(`resolve?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resolve?` | `P` | - -#### Returns - -`void` - -#### Defined in - -[src/utils/SubscribableObserver.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribableObserver.ts#L30) - -___ - -### emit - -▸ `Private` **emit**(`type`, `value`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | ``"onError"`` \| ``"onNext"`` \| ``"onComplete"`` | -| `value` | `any` | - -#### Returns - -`void` - -#### Defined in - -[src/utils/SubscribableObserver.ts:40](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribableObserver.ts#L40) - -___ - -### error - -▸ **error**(`error?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error?` | `any` | - -#### Returns - -`void` - -#### Defined in - -[src/utils/SubscribableObserver.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribableObserver.ts#L35) - -___ - -### next - -▸ **next**(`next?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `next?` | `T` | - -#### Returns - -`void` - -#### Defined in - -[src/utils/SubscribableObserver.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribableObserver.ts#L26) - -___ - -### subscribe - -▸ **subscribe**(`onNext?`, `onComplete?`, `onError?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `onNext?` | (`next`: `T`) => `void` | -| `onComplete?` | (`complete`: `P`) => `void` | -| `onError?` | (`error`: `any`) => `void` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `unsubscribe` | () => `boolean` | - -#### Defined in - -[src/utils/SubscribableObserver.ts:10](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribableObserver.ts#L10) - -___ - -### unsubscribe - -▸ `Private` **unsubscribe**(): `void` - -#### Returns - -`void` - -#### Defined in - -[src/utils/SubscribableObserver.ts:47](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribableObserver.ts#L47) diff --git a/docs/nevermined-sdk/api-reference/classes/utils.SubscribablePromise.md b/docs/nevermined-sdk/api-reference/classes/utils.SubscribablePromise.md deleted file mode 100644 index b992857f41..0000000000 --- a/docs/nevermined-sdk/api-reference/classes/utils.SubscribablePromise.md +++ /dev/null @@ -1,200 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [utils](../modules/utils.md) / SubscribablePromise - -# Class: SubscribablePromise - -[utils](../modules/utils.md).SubscribablePromise - -## Type parameters - -| Name | -| :------ | -| `T` | -| `P` | - -## Table of contents - -### Constructors - -- [constructor](utils.SubscribablePromise.md#constructor) - -### Properties - -- [observer](utils.SubscribablePromise.md#observer) -- [promise](utils.SubscribablePromise.md#promise) - -### Methods - -- [catch](utils.SubscribablePromise.md#catch) -- [finally](utils.SubscribablePromise.md#finally) -- [init](utils.SubscribablePromise.md#init) -- [next](utils.SubscribablePromise.md#next) -- [subscribe](utils.SubscribablePromise.md#subscribe) -- [then](utils.SubscribablePromise.md#then) - -## Constructors - -### constructor - -• **new SubscribablePromise**<`T`, `P`\>(`executor`) - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `P` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `executor` | (`observer`: [`SubscribableObserver`](utils.SubscribableObserver.md)<`T`, `P`\>) => `void` \| `Promise`<`P`\> | - -#### Defined in - -[src/utils/SubscribablePromise.ts:15](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribablePromise.ts#L15) - -## Properties - -### observer - -• `Private` **observer**: [`SubscribableObserver`](utils.SubscribableObserver.md)<`T`, `P`\> - -#### Defined in - -[src/utils/SubscribablePromise.ts:4](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribablePromise.ts#L4) - -___ - -### promise - -• `Private` **promise**: `Promise`<`P`\> & [`SubscribablePromise`](utils.SubscribablePromise.md)<`T`, `P`\> - -#### Defined in - -[src/utils/SubscribablePromise.ts:6](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribablePromise.ts#L6) - -## Methods - -### catch - -▸ **catch**(`onrejected?`): `Promise`<`any`\> & [`SubscribablePromise`](utils.SubscribablePromise.md)<`T`, `P`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `onrejected?` | (`error`: `any`) => `any` | - -#### Returns - -`Promise`<`any`\> & [`SubscribablePromise`](utils.SubscribablePromise.md)<`T`, `P`\> - -#### Defined in - -[src/utils/SubscribablePromise.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribablePromise.ts#L33) - -___ - -### finally - -▸ **finally**(`onfinally?`): `Promise`<`P`\> & [`SubscribablePromise`](utils.SubscribablePromise.md)<`T`, `P`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `onfinally?` | () => `any` | - -#### Returns - -`Promise`<`P`\> & [`SubscribablePromise`](utils.SubscribablePromise.md)<`T`, `P`\> - -#### Defined in - -[src/utils/SubscribablePromise.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribablePromise.ts#L37) - -___ - -### init - -▸ `Private` **init**(`executor`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `executor` | (`observer`: [`SubscribableObserver`](utils.SubscribableObserver.md)<`T`, `P`\>) => `void` \| `Promise`<`P`\> | - -#### Returns - -`void` - -#### Defined in - -[src/utils/SubscribablePromise.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribablePromise.ts#L41) - -___ - -### next - -▸ **next**(`onNext`): [`SubscribablePromise`](utils.SubscribablePromise.md)<`T`, `P`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `onNext` | (`next`: `T`) => `void` | - -#### Returns - -[`SubscribablePromise`](utils.SubscribablePromise.md)<`T`, `P`\> - -#### Defined in - -[src/utils/SubscribablePromise.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribablePromise.ts#L24) - -___ - -### subscribe - -▸ **subscribe**(`onNext`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `onNext` | (`next`: `T`) => `void` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `unsubscribe` | () => `boolean` | - -#### Defined in - -[src/utils/SubscribablePromise.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribablePromise.ts#L20) - -___ - -### then - -▸ **then**(`onfulfilled?`, `onrejected?`): `Promise`<`any`\> & [`SubscribablePromise`](utils.SubscribablePromise.md)<`T`, `P`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `onfulfilled?` | (`value`: `P`) => `any` | -| `onrejected?` | (`error`: `any`) => `any` | - -#### Returns - -`Promise`<`any`\> & [`SubscribablePromise`](utils.SubscribablePromise.md)<`T`, `P`\> - -#### Defined in - -[src/utils/SubscribablePromise.ts:29](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribablePromise.ts#L29) diff --git a/docs/nevermined-sdk/api-reference/code-reference.md b/docs/nevermined-sdk/api-reference/code-reference.md index a1c959389b..0460199c29 100644 --- a/docs/nevermined-sdk/api-reference/code-reference.md +++ b/docs/nevermined-sdk/api-reference/code-reference.md @@ -263,13 +263,13 @@ ### Variables - [ConditionStateNames](code-reference.md#conditionstatenames) -- [DEFAULT_ENCRYPTION_METHOD](code-reference.md#default_encryption_method) -- [DEFAULT_REGISTRATION_ACTIVITY_ID](code-reference.md#default_registration_activity_id) -- [DEPENDENCIES_RELEASE_CONDITION](code-reference.md#dependencies_release_condition) +- [DEFAULT\_ENCRYPTION\_METHOD](code-reference.md#default_encryption_method) +- [DEFAULT\_REGISTRATION\_ACTIVITY\_ID](code-reference.md#default_registration_activity_id) +- [DEPENDENCIES\_RELEASE\_CONDITION](code-reference.md#dependencies_release_condition) - [DefaultPaymentAttributes](code-reference.md#defaultpaymentattributes) - [Logger](code-reference.md#logger) -- [NETWORK_FEE_DENOMINATOR](code-reference.md#network_fee_denominator) -- [SALES_SERVICES](code-reference.md#sales_services) +- [NETWORK\_FEE\_DENOMINATOR](code-reference.md#network_fee_denominator) +- [SALES\_SERVICES](code-reference.md#sales_services) - [ZeroAddress](code-reference.md#zeroaddress) - [apiPath](code-reference.md#apipath) - [defaultNeverminedNFTType](code-reference.md#defaultneverminednfttype) @@ -346,33 +346,33 @@ Renames and re-exports [Logger](code-reference.md#logger) ### ConditionMethod -Ƭ **ConditionMethod**: `"fulfill"` \| `"fulfillForDelegate"` +Ƭ **ConditionMethod**: ``"fulfill"`` \| ``"fulfillForDelegate"`` #### Defined in -[src/types/ContractTypes.ts:10](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/ContractTypes.ts#L10) +[src/types/ContractTypes.ts:10](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/ContractTypes.ts#L10) ---- +___ ### ConditionType -Ƭ **ConditionType**: `"lockPayment"` \| `"escrowPayment"` \| `"nftHolder"` \| `"transferNFT"` +Ƭ **ConditionType**: ``"lockPayment"`` \| ``"escrowPayment"`` \| ``"nftHolder"`` \| ``"transferNFT"`` #### Defined in -[src/types/DDOTypes.ts:606](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L606) +[src/types/DDOTypes.ts:606](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L606) ---- +___ ### EncryptionMethod -Ƭ **EncryptionMethod**: `"PSK-RSA"` \| `"PSK-ECDSA"` +Ƭ **EncryptionMethod**: ``"PSK-RSA"`` \| ``"PSK-ECDSA"`` #### Defined in -[src/constants/AssetConstants.ts:4](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/constants/AssetConstants.ts#L4) +[src/constants/AssetConstants.ts:4](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/constants/AssetConstants.ts#L4) ---- +___ ### EventResult @@ -380,9 +380,9 @@ Renames and re-exports [Logger](code-reference.md#logger) #### Defined in -[src/types/EventTypes.ts:25](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/EventTypes.ts#L25) +[src/types/EventTypes.ts:25](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/EventTypes.ts#L25) ---- +___ ### NeverminedNFTType @@ -390,9 +390,9 @@ Renames and re-exports [Logger](code-reference.md#logger) #### Defined in -[src/types/GeneralTypes.ts:31](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L31) +[src/types/GeneralTypes.ts:31](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L31) ---- +___ ### ParameterType @@ -400,9 +400,9 @@ Renames and re-exports [Logger](code-reference.md#logger) #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:23](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L23) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:23](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L23) ---- +___ ### PricedMetadataInformation @@ -410,19 +410,19 @@ Renames and re-exports [Logger](code-reference.md#logger) #### Type declaration -| Name | Type | -| :---------------------------------------------------------- | :------------------------------------------------------------------------------------------------------- | -| `attributes` | \{ `additionalInformation`: \{ `priceHighestDenomination`: `number` } ; `main`: \{ `price`: `string` } } | -| `attributes.additionalInformation` | \{ `priceHighestDenomination`: `number` } | -| `attributes.additionalInformation.priceHighestDenomination` | `number` | -| `attributes.main` | \{ `price`: `string` } | -| `attributes.main.price` | `string` | +| Name | Type | +| :------ | :------ | +| `attributes` | \{ `additionalInformation`: \{ `priceHighestDenomination`: `number` } ; `main`: \{ `price`: `string` } } | +| `attributes.additionalInformation` | \{ `priceHighestDenomination`: `number` } | +| `attributes.additionalInformation.priceHighestDenomination` | `number` | +| `attributes.main` | \{ `price`: `string` } | +| `attributes.main.price` | `string` | #### Defined in -[src/types/DDOTypes.ts:644](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L644) +[src/types/DDOTypes.ts:644](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L644) ---- +___ ### ProvenanceEvent @@ -430,39 +430,39 @@ Renames and re-exports [Logger](code-reference.md#logger) #### Type parameters -| Name | Type | -| :--- | :----------------------------------------------------------------------- | -| `T` | extends [`ProvenanceMethod`](enums/ProvenanceMethod.md) \| `any` = `any` | +| Name | Type | +| :------ | :------ | +| `T` | extends [`ProvenanceMethod`](enums/ProvenanceMethod.md) \| `any` = `any` | #### Defined in -[src/keeper/contracts/Provenance.ts:80](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L80) +[src/keeper/contracts/Provenance.ts:80](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L80) ---- +___ ### Service -Ƭ **Service**\<`T`\>: `T` extends `"authorization"` ? [`ServiceAuthorization`](interfaces/ServiceAuthorization.md) : `T` extends `"metadata"` ? [`ServiceMetadata`](interfaces/ServiceMetadata.md) : `T` extends `"nft-access"` ? [`ServiceNFTAccess`](interfaces/ServiceNFTAccess.md) : `T` extends `"nft-sales"` ? [`ServiceNFTSales`](interfaces/ServiceNFTSales.md) : `T` extends `"access"` ? [`ServiceAccess`](interfaces/ServiceAccess.md) : `T` extends `"compute"` ? [`ServiceCompute`](interfaces/ServiceCompute.md) : `T` extends `"default"` ? [`ServiceCommon`](interfaces/ServiceCommon.md) : [`ServiceCommon`](interfaces/ServiceCommon.md) +Ƭ **Service**\<`T`\>: `T` extends ``"authorization"`` ? [`ServiceAuthorization`](interfaces/ServiceAuthorization.md) : `T` extends ``"metadata"`` ? [`ServiceMetadata`](interfaces/ServiceMetadata.md) : `T` extends ``"nft-access"`` ? [`ServiceNFTAccess`](interfaces/ServiceNFTAccess.md) : `T` extends ``"nft-sales"`` ? [`ServiceNFTSales`](interfaces/ServiceNFTSales.md) : `T` extends ``"access"`` ? [`ServiceAccess`](interfaces/ServiceAccess.md) : `T` extends ``"compute"`` ? [`ServiceCompute`](interfaces/ServiceCompute.md) : `T` extends ``"default"`` ? [`ServiceCommon`](interfaces/ServiceCommon.md) : [`ServiceCommon`](interfaces/ServiceCommon.md) #### Type parameters -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `T` | extends [`ServiceType`](code-reference.md#servicetype) \| `"default"` = `"default"` | +| Name | Type | +| :------ | :------ | +| `T` | extends [`ServiceType`](code-reference.md#servicetype) \| ``"default"`` = ``"default"`` | #### Defined in -[src/types/DDOTypes.ts:765](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L765) +[src/types/DDOTypes.ts:765](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L765) ---- +___ ### ServiceType -Ƭ **ServiceType**: `"authorization"` \| `"metadata"` \| `"access"` \| `"compute"` \| `"workflow"` \| `"nft-access"` \| `"nft-sales"` \| `"nft-sales-proof"` +Ƭ **ServiceType**: ``"authorization"`` \| ``"metadata"`` \| ``"access"`` \| ``"compute"`` \| ``"workflow"`` \| ``"nft-access"`` \| ``"nft-sales"`` \| ``"nft-sales-proof"`` #### Defined in -[src/types/DDOTypes.ts:608](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L608) +[src/types/DDOTypes.ts:608](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L608) ## Variables @@ -472,23 +472,23 @@ Renames and re-exports [Logger](code-reference.md#logger) #### Defined in -[src/types/ContractTypes.ts:8](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/ContractTypes.ts#L8) +[src/types/ContractTypes.ts:8](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/ContractTypes.ts#L8) ---- +___ -### DEFAULT_ENCRYPTION_METHOD +### DEFAULT\_ENCRYPTION\_METHOD -• `Const` **DEFAULT_ENCRYPTION_METHOD**: [`EncryptionMethod`](code-reference.md#encryptionmethod) +• `Const` **DEFAULT\_ENCRYPTION\_METHOD**: [`EncryptionMethod`](code-reference.md#encryptionmethod) #### Defined in -[src/constants/AssetConstants.ts:7](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/constants/AssetConstants.ts#L7) +[src/constants/AssetConstants.ts:7](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/constants/AssetConstants.ts#L7) ---- +___ -### DEFAULT_REGISTRATION_ACTIVITY_ID +### DEFAULT\_REGISTRATION\_ACTIVITY\_ID -• `Const` **DEFAULT_REGISTRATION_ACTIVITY_ID**: `"AssetRegistration"` +• `Const` **DEFAULT\_REGISTRATION\_ACTIVITY\_ID**: ``"AssetRegistration"`` Identifies the default Provenance Activity Id to be recorded on-chain in the DIDRegistry Smart Contract when an asset is registered. It associates to the new DID created the 'Asset Registration' activity. @@ -496,19 +496,19 @@ an asset is registered. It associates to the new DID created the 'Asset Registra #### Defined in -[src/keeper/contracts/Provenance.ts:7](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L7) +[src/keeper/contracts/Provenance.ts:7](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L7) ---- +___ -### DEPENDENCIES_RELEASE_CONDITION +### DEPENDENCIES\_RELEASE\_CONDITION -• `Const` **DEPENDENCIES_RELEASE_CONDITION**: `string`[] +• `Const` **DEPENDENCIES\_RELEASE\_CONDITION**: `string`[] #### Defined in -[src/ddo/DDO.ts:36](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L36) +[src/ddo/DDO.ts:36](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L36) ---- +___ ### DefaultPaymentAttributes @@ -516,9 +516,9 @@ an asset is registered. It associates to the new DID created the 'Asset Registra #### Defined in -[src/types/DDOTypes.ts:74](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L74) +[src/types/DDOTypes.ts:74](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L74) ---- +___ ### Logger @@ -526,49 +526,49 @@ an asset is registered. It associates to the new DID created the 'Asset Registra #### Defined in -[src/models/Logger.ts:43](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/Logger.ts#L43) +[src/models/Logger.ts:43](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/Logger.ts#L43) ---- +___ -### NETWORK_FEE_DENOMINATOR +### NETWORK\_FEE\_DENOMINATOR -• `Const` **NETWORK_FEE_DENOMINATOR**: `10000n` +• `Const` **NETWORK\_FEE\_DENOMINATOR**: `10000n` #### Defined in -[src/constants/AssetConstants.ts:1](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/constants/AssetConstants.ts#L1) +[src/constants/AssetConstants.ts:1](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/constants/AssetConstants.ts#L1) ---- +___ -### SALES_SERVICES +### SALES\_SERVICES -• `Const` **SALES_SERVICES**: `string`[] +• `Const` **SALES\_SERVICES**: `string`[] #### Defined in -[src/ddo/DDO.ts:34](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L34) +[src/ddo/DDO.ts:34](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L34) ---- +___ ### ZeroAddress -• `Const` **ZeroAddress**: `"0x0000000000000000000000000000000000000000"` +• `Const` **ZeroAddress**: ``"0x0000000000000000000000000000000000000000"`` #### Defined in -[src/constants/AssetConstants.ts:10](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/constants/AssetConstants.ts#L10) +[src/constants/AssetConstants.ts:10](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/constants/AssetConstants.ts#L10) ---- +___ ### apiPath -• `Const` **apiPath**: `"/api/v1/metadata/assets/ddo"` +• `Const` **apiPath**: ``"/api/v1/metadata/assets/ddo"`` #### Defined in -[src/services/metadata/MetadataService.ts:8](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L8) +[src/services/metadata/MetadataService.ts:8](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L8) ---- +___ ### defaultNeverminedNFTType @@ -576,16 +576,16 @@ an asset is registered. It associates to the new DID created the 'Asset Registra #### Type declaration -| Name | Type | -| :----- | :-------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `1155` | [`NeverminedNFT1155Type`](enums/NeverminedNFT1155Type.md) | -| `721` | [`NeverminedNFT721Type`](enums/NeverminedNFT721Type.md) | +| `721` | [`NeverminedNFT721Type`](enums/NeverminedNFT721Type.md) | #### Defined in -[src/types/GeneralTypes.ts:40](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L40) +[src/types/GeneralTypes.ts:40](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L40) ---- +___ ### ercOfNeverminedNFTType @@ -593,18 +593,18 @@ an asset is registered. It associates to the new DID created the 'Asset Registra #### Type declaration -| Name | Type | -| :-------------------- | :---------------------------- | -| `nft1155` | [`ERCType`](enums/ERCType.md) | -| `nft1155-credit` | [`ERCType`](enums/ERCType.md) | -| `nft721` | [`ERCType`](enums/ERCType.md) | +| Name | Type | +| :------ | :------ | +| `nft1155` | [`ERCType`](enums/ERCType.md) | +| `nft1155-credit` | [`ERCType`](enums/ERCType.md) | +| `nft721` | [`ERCType`](enums/ERCType.md) | | `nft721-subscription` | [`ERCType`](enums/ERCType.md) | #### Defined in -[src/types/GeneralTypes.ts:33](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L33) +[src/types/GeneralTypes.ts:33](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L33) ---- +___ ### serviceIndex @@ -612,47 +612,47 @@ an asset is registered. It associates to the new DID created the 'Asset Registra #### Type declaration -| Name | Type | -| :-------------------- | :------- | -| `access` | `number` | -| `access-proof` | `number` | -| `authorization` | `number` | -| `compute` | `number` | -| `metadata` | `number` | -| `nft-access` | `number` | -| `nft-access-proof` | `number` | -| `nft-sales` | `number` | -| `nft-sales-proof` | `number` | -| `nft721-access` | `number` | +| Name | Type | +| :------ | :------ | +| `access` | `number` | +| `access-proof` | `number` | +| `authorization` | `number` | +| `compute` | `number` | +| `metadata` | `number` | +| `nft-access` | `number` | +| `nft-access-proof` | `number` | +| `nft-sales` | `number` | +| `nft-sales-proof` | `number` | +| `nft721-access` | `number` | | `nft721-access-proof` | `number` | -| `nft721-sales` | `number` | -| `nft721-sales-proof` | `number` | -| `workflow` | `number` | +| `nft721-sales` | `number` | +| `nft721-sales-proof` | `number` | +| `workflow` | `number` | #### Defined in -[src/types/DDOTypes.ts:618](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L618) +[src/types/DDOTypes.ts:618](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L618) ---- +___ ### servicePath -• `Const` **servicePath**: `"/api/v1/metadata/assets/service"` +• `Const` **servicePath**: ``"/api/v1/metadata/assets/service"`` #### Defined in -[src/services/metadata/MetadataService.ts:9](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L9) +[src/services/metadata/MetadataService.ts:9](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L9) ## Functions ### \_sleep -▸ **\_sleep**(`ms`): `Promise`\<`unknown`\> +▸ **_sleep**(`ms`): `Promise`\<`unknown`\> #### Parameters -| Name | Type | -| :--- | :------- | +| Name | Type | +| :------ | :------ | | `ms` | `number` | #### Returns @@ -661,9 +661,9 @@ an asset is registered. It associates to the new DID created the 'Asset Registra #### Defined in -[src/common/helpers.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/common/helpers.ts#L47) +[src/common/helpers.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/common/helpers.ts#L47) ---- +___ ### buildQuery @@ -671,9 +671,9 @@ an asset is registered. It associates to the new DID created the 'Asset Registra #### Parameters -| Name | Type | -| :------- | :----------------------------------------- | -| `url` | `string` | +| Name | Type | +| :------ | :------ | +| `url` | `string` | | `query?` | [`SearchQuery`](interfaces/SearchQuery.md) | #### Returns @@ -682,9 +682,9 @@ an asset is registered. It associates to the new DID created the 'Asset Registra #### Defined in -[src/common/helpers.ts:7](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/common/helpers.ts#L7) +[src/common/helpers.ts:7](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/common/helpers.ts#L7) ---- +___ ### checkContractExists @@ -694,71 +694,71 @@ Given a contract address it checks if the contract exists on the blockchain. #### Parameters -| Name | Type | Description | -| :-------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contractAddress` | `string` | the contract address | -| `client` | `Object` | the client to interact with the blockchain | -| `client.account` | `undefined` | The Account of the Client. | -| `client.batch?` | `Object` | Flags for batch settings. | -| `client.batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `client.cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `client.call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | Executes a new message call immediately without submitting a transaction to the network. - Docs: https://viem.sh/docs/actions/public/call - JSON-RPC Methods: [`eth_call`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_call) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const data = await client.call({ account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', }) ` | -| `client.ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `client.chain` | `undefined` \| `Chain` | Chain for the client. | -| `client.createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | Creates a Filter to listen for new block hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges). - Docs: https://viem.sh/docs/actions/public/createBlockFilter - JSON-RPC Methods: [`eth_newBlockFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newBlockFilter) **`Example`** `ts import { createPublicClient, createBlockFilter, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await createBlockFilter(client) // { id: "0x345a6572337856574a76364e457a4366", type: 'block' } ` | -| `client.createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges) or [`getFilterLogs`](https://viem.sh/docs/actions/public/getFilterLogs). - Docs: https://viem.sh/docs/contract/createContractEventFilter **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createContractEventFilter({ abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']), }) ` | -| `client.createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | Creates a [`Filter`](https://viem.sh/docs/glossary/types#filter) to listen for new events that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges). - Docs: https://viem.sh/docs/actions/public/createEventFilter - JSON-RPC Methods: [`eth_newFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newfilter) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createEventFilter({ address: '0xfba3912ca04dd458c843e2ee08967fc04f3579c2', }) ` | -| `client.createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | Creates a Filter to listen for new pending transaction hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges). - Docs: https://viem.sh/docs/actions/public/createPendingTransactionFilter - JSON-RPC Methods: [`eth_newPendingTransactionFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newpendingtransactionfilter) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createPendingTransactionFilter() // { id: "0x345a6572337856574a76364e457a4366", type: 'transaction' } ` | -| `client.estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | Estimates the gas required to successfully execute a contract write function call. - Docs: https://viem.sh/docs/contract/estimateContractGas **`Remarks`** Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`estimateGas` action](https://viem.sh/docs/actions/public/estimateGas) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData). **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const gas = await client.estimateContractGas({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function mint() public']), functionName: 'mint', account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', }) ` | -| `client.estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | Returns an estimate for the fees per gas for a transaction to be included in the next block. - Docs: https://viem.sh/docs/actions/public/estimateFeesPerGas **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const maxPriorityFeePerGas = await client.estimateFeesPerGas() // { maxFeePerGas: ..., maxPriorityFeePerGas: ... } ` | -| `client.estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | Estimates the gas necessary to complete a transaction without submitting it to the network. - Docs: https://viem.sh/docs/actions/public/estimateGas - JSON-RPC Methods: [`eth_estimateGas`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_estimategas) **`Example`** `ts import { createPublicClient, http, parseEther } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const gasEstimate = await client.estimateGas({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', value: parseEther('1'), }) ` | -| `client.estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | Returns an estimate for the max priority fee per gas (in wei) for a transaction to be included in the next block. - Docs: https://viem.sh/docs/actions/public/estimateMaxPriorityFeePerGas **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const maxPriorityFeePerGas = await client.estimateMaxPriorityFeePerGas() // 10000000n ` | -| `client.extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `client.getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | Returns the balance of an address in wei. - Docs: https://viem.sh/docs/actions/public/getBalance - JSON-RPC Methods: [`eth_getBalance`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getbalance) **`Remarks`** You can convert the balance to ether units with [`formatEther`](https://viem.sh/docs/utilities/formatEther). `ts const balance = await getBalance(client, { address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', blockTag: 'safe' }) const balanceAsEther = formatEther(balance) // "6.942" ` **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const balance = await client.getBalance({ address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', }) // 10000000000000000000000n (wei) ` | -| `client.getBlobBaseFee` | () => `Promise`\<`bigint`\> | Returns the base fee per blob gas in wei. - Docs: https://viem.sh/docs/actions/public/getBlobBaseFee - JSON-RPC Methods: [`eth_blobBaseFee`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blobBaseFee) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { getBlobBaseFee } from 'viem/public' const client = createPublicClient({ chain: mainnet, transport: http(), }) const blobBaseFee = await client.getBlobBaseFee() ` | -| `client.getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | Returns information about a block at a block number, hash, or tag. - Docs: https://viem.sh/docs/actions/public/getBlock - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/fetching-blocks - JSON-RPC Methods: - Calls [`eth_getBlockByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbynumber) for `blockNumber` & `blockTag`. - Calls [`eth_getBlockByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbyhash) for `blockHash`. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const block = await client.getBlock() ` | -| `client.getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | Returns the number of the most recent block seen. - Docs: https://viem.sh/docs/actions/public/getBlockNumber - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/fetching-blocks - JSON-RPC Methods: [`eth_blockNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blocknumber) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const blockNumber = await client.getBlockNumber() // 69420n ` | -| `client.getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | Returns the number of Transactions at a block number, hash, or tag. - Docs: https://viem.sh/docs/actions/public/getBlockTransactionCount - JSON-RPC Methods: - Calls [`eth_getBlockTransactionCountByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblocktransactioncountbynumber) for `blockNumber` & `blockTag`. - Calls [`eth_getBlockTransactionCountByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblocktransactioncountbyhash) for `blockHash`. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const count = await client.getBlockTransactionCount() ` | -| `client.getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | Retrieves the bytecode at an address. - Docs: https://viem.sh/docs/contract/getBytecode - JSON-RPC Methods: [`eth_getCode`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getcode) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const code = await client.getBytecode({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', }) ` | -| `client.getChainId` | () => `Promise`\<`number`\> | Returns the chain ID associated with the current network. - Docs: https://viem.sh/docs/actions/public/getChainId - JSON-RPC Methods: [`eth_chainId`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_chainid) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const chainId = await client.getChainId() // 1 ` | -| `client.getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | Returns a list of event logs emitted by a contract. - Docs: https://viem.sh/docs/actions/public/getContractEvents - JSON-RPC Methods: [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { wagmiAbi } from './abi' const client = createPublicClient({ chain: mainnet, transport: http(), }) const logs = await client.getContractEvents(client, { address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: wagmiAbi, eventName: 'Transfer' }) ` | -| `client.getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | Gets address for ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsAddress - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const ensAddress = await client.getEnsAddress({ name: normalize('wevm.eth'), }) // '0xd2135CfB216b74109775236E36d4b433F1DF507B' ` | -| `client.getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | Gets the avatar of an ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsAvatar - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls [`getEnsText`](https://viem.sh/docs/ens/actions/getEnsText) with `key` set to `'avatar'`. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const ensAvatar = await client.getEnsAvatar({ name: normalize('wevm.eth'), }) // 'https://ipfs.io/ipfs/Qma8mnp6xV3J2cRNf3mTth5C8nV11CAnceVinc3y8jSbio' ` | -| `client.getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | Gets primary name for specified address. - Docs: https://viem.sh/docs/ens/actions/getEnsName - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `reverse(bytes)` on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const ensName = await client.getEnsName({ address: '0xd2135CfB216b74109775236E36d4b433F1DF507B', }) // 'wevm.eth' ` | -| `client.getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | Gets resolver for ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsResolver - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `findResolver(bytes)` on ENS Universal Resolver Contract to retrieve the resolver of an ENS name. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const resolverAddress = await client.getEnsResolver({ name: normalize('wevm.eth'), }) // '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41' ` | -| `client.getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | Gets a text record for specified ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsResolver - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const twitterRecord = await client.getEnsText({ name: normalize('wevm.eth'), key: 'com.twitter', }) // 'wagmi_sh' ` | -| `client.getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | Returns a collection of historical gas information. - Docs: https://viem.sh/docs/actions/public/getFeeHistory - JSON-RPC Methods: [`eth_feeHistory`](https://docs.alchemy.com/reference/eth-feehistory) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const feeHistory = await client.getFeeHistory({ blockCount: 4, rewardPercentiles: [25, 75], }) ` | -| `client.getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Returns a list of logs or hashes based on a [Filter](/docs/glossary/terms#filter) since the last time it was called. - Docs: https://viem.sh/docs/actions/public/getFilterChanges - JSON-RPC Methods: [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterchanges) **`Remarks`** A Filter can be created from the following actions: - [`createBlockFilter`](https://viem.sh/docs/actions/public/createBlockFilter) - [`createContractEventFilter`](https://viem.sh/docs/contract/createContractEventFilter) - [`createEventFilter`](https://viem.sh/docs/actions/public/createEventFilter) - [`createPendingTransactionFilter`](https://viem.sh/docs/actions/public/createPendingTransactionFilter) Depending on the type of filter, the return value will be different: - If the filter was created with `createContractEventFilter` or `createEventFilter`, it returns a list of logs. - If the filter was created with `createPendingTransactionFilter`, it returns a list of transaction hashes. - If the filter was created with `createBlockFilter`, it returns a list of block hashes. **`Example`** `ts // Blocks import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createBlockFilter() const hashes = await client.getFilterChanges({ filter }) ` **`Example`** `ts // Contract Events import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createContractEventFilter({ address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']), eventName: 'Transfer', }) const logs = await client.getFilterChanges({ filter }) ` **`Example`** `ts // Raw Events import { createPublicClient, http, parseAbiItem } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createEventFilter({ address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', event: parseAbiItem('event Transfer(address indexed, address indexed, uint256)'), }) const logs = await client.getFilterChanges({ filter }) ` **`Example`** `ts // Transactions import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createPendingTransactionFilter() const hashes = await client.getFilterChanges({ filter }) ` | -| `client.getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Returns a list of event logs since the filter was created. - Docs: https://viem.sh/docs/actions/public/getFilterLogs - JSON-RPC Methods: [`eth_getFilterLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterlogs) **`Remarks`** `getFilterLogs` is only compatible with **event filters**. **`Example`** `ts import { createPublicClient, http, parseAbiItem } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createEventFilter({ address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', event: parseAbiItem('event Transfer(address indexed, address indexed, uint256)'), }) const logs = await client.getFilterLogs({ filter }) ` | -| `client.getGasPrice` | () => `Promise`\<`bigint`\> | Returns the current price of gas (in wei). - Docs: https://viem.sh/docs/actions/public/getGasPrice - JSON-RPC Methods: [`eth_gasPrice`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gasprice) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const gasPrice = await client.getGasPrice() ` | -| `client.getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Returns a list of event logs matching the provided parameters. - Docs: https://viem.sh/docs/actions/public/getLogs - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/filters-and-logs/event-logs - JSON-RPC Methods: [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs) **`Example`** `ts import { createPublicClient, http, parseAbiItem } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const logs = await client.getLogs() ` | -| `client.getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | Returns the account and storage values of the specified account including the Merkle-proof. - Docs: https://viem.sh/docs/actions/public/getProof - JSON-RPC Methods: - Calls [`eth_getProof`](https://eips.ethereum.org/EIPS/eip-1186) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const block = await client.getProof({ address: '0x...', storageKeys: ['0x...'], }) ` | -| `client.getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | Returns the value from a storage slot at a given address. - Docs: https://viem.sh/docs/contract/getStorageAt - JSON-RPC Methods: [`eth_getStorageAt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getstorageat) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { getStorageAt } from 'viem/contract' const client = createPublicClient({ chain: mainnet, transport: http(), }) const code = await client.getStorageAt({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', slot: toHex(0), }) ` | -| `client.getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | Returns information about a [Transaction](https://viem.sh/docs/glossary/terms#transaction) given a hash or block identifier. - Docs: https://viem.sh/docs/actions/public/getTransaction - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions - JSON-RPC Methods: [`eth_getTransactionByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionByHash) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transaction = await client.getTransaction({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ` | -| `client.getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | Returns the number of blocks passed (confirmations) since the transaction was processed on a block. - Docs: https://viem.sh/docs/actions/public/getTransactionConfirmations - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions - JSON-RPC Methods: [`eth_getTransactionConfirmations`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionConfirmations) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const confirmations = await client.getTransactionConfirmations({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ` | -| `client.getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | Returns the number of [Transactions](https://viem.sh/docs/glossary/terms#transaction) an Account has broadcast / sent. - Docs: https://viem.sh/docs/actions/public/getTransactionCount - JSON-RPC Methods: [`eth_getTransactionCount`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gettransactioncount) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transactionCount = await client.getTransactionCount({ address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', }) ` | -| `client.getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | Returns the [Transaction Receipt](https://viem.sh/docs/glossary/terms#transaction-receipt) given a [Transaction](https://viem.sh/docs/glossary/terms#transaction) hash. - Docs: https://viem.sh/docs/actions/public/getTransactionReceipt - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions - JSON-RPC Methods: [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionReceipt) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transactionReceipt = await client.getTransactionReceipt({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ` | -| `client.key` | `string` | A key for the client. | -| `client.multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | Similar to [`readContract`](https://viem.sh/docs/contract/readContract), but batches up multiple functions on a contract in a single RPC call via the [`multicall3` contract](https://github.com/mds1/multicall). - Docs: https://viem.sh/docs/contract/multicall **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const abi = parseAbi([ 'function balanceOf(address) view returns (uint256)', 'function totalSupply() view returns (uint256)', ]) const result = await client.multicall({ contracts: [ { address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi, functionName: 'balanceOf', args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'], }, { address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi, functionName: 'totalSupply', }, ], }) // [{ result: 424122n, status: 'success' }, { result: 1000000n, status: 'success' }] ` | -| `client.name` | `string` | A name for the client. | -| `client.pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `client.prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | Prepares a transaction request for signing. - Docs: https://viem.sh/docs/actions/wallet/prepareTransactionRequest **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const request = await client.prepareTransactionRequest({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', to: '0x0000000000000000000000000000000000000000', value: 1n, }) ` **`Example`** `ts // Account Hoisting import { createWalletClient, http } from 'viem' import { privateKeyToAccount } from 'viem/accounts' import { mainnet } from 'viem/chains' const client = createWalletClient({ account: privateKeyToAccount('0x…'), chain: mainnet, transport: custom(window.ethereum), }) const request = await client.prepareTransactionRequest({ to: '0x0000000000000000000000000000000000000000', value: 1n, }) ` | -| `client.readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | Calls a read-only function on a contract, and returns the response. - Docs: https://viem.sh/docs/contract/readContract - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/reading-contracts **`Remarks`** A "read-only" function (constant function) on a Solidity contract is denoted by a `view` or `pure` keyword. They can only read the state of the contract, and cannot make any changes to it. Since read-only methods do not change the state of the contract, they do not require any gas to be executed, and can be called by any user without the need to pay for gas. Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`call` action](https://viem.sh/docs/actions/public/call) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData). **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' import { readContract } from 'viem/contract' const client = createPublicClient({ chain: mainnet, transport: http(), }) const result = await client.readContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function balanceOf(address) view returns (uint256)']), functionName: 'balanceOf', args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'], }) // 424122n ` | -| `client.request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `client.sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | Sends a **signed** transaction to the network - Docs: https://viem.sh/docs/actions/wallet/sendRawTransaction - JSON-RPC Method: [`eth_sendRawTransaction`](https://ethereum.github.io/execution-apis/api-documentation/) **`Example`** `ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' import { sendRawTransaction } from 'viem/wallet' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const hash = await client.sendRawTransaction({ serializedTransaction: '0x02f850018203118080825208808080c080a04012522854168b27e5dc3d5839bab5e6b39e1a0ffd343901ce1622e3d64b48f1a04e00902ae0502c4728cbf12156290df99c3ed7de85b1dbfe20b5c36931733a33' }) ` | -| `client.simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | Simulates/validates a contract interaction. This is useful for retrieving **return data** and **revert reasons** of contract write functions. - Docs: https://viem.sh/docs/contract/simulateContract - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/writing-to-contracts **`Remarks`** This function does not require gas to execute and _**does not**_ change the state of the blockchain. It is almost identical to [`readContract`](https://viem.sh/docs/contract/readContract), but also supports contract write functions. Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`call` action](https://viem.sh/docs/actions/public/call) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData). **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const result = await client.simulateContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function mint(uint32) view returns (uint32)']), functionName: 'mint', args: ['69420'], account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', }) ` | -| `client.transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `client.type` | `string` | The type of client. | -| `client.uid` | `string` | A unique ID for the client. | -| `client.uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | Destroys a Filter that was created from one of the following Actions: - [`createBlockFilter`](https://viem.sh/docs/actions/public/createBlockFilter) - [`createEventFilter`](https://viem.sh/docs/actions/public/createEventFilter) - [`createPendingTransactionFilter`](https://viem.sh/docs/actions/public/createPendingTransactionFilter) - Docs: https://viem.sh/docs/actions/public/uninstallFilter - JSON-RPC Methods: [`eth_uninstallFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_uninstallFilter) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { createPendingTransactionFilter, uninstallFilter } from 'viem/public' const filter = await client.createPendingTransactionFilter() const uninstalled = await client.uninstallFilter({ filter }) // true ` | -| `client.verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `client.verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `client.waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | Waits for the [Transaction](https://viem.sh/docs/glossary/terms#transaction) to be included on a [Block](https://viem.sh/docs/glossary/terms#block) (one confirmation), and then returns the [Transaction Receipt](https://viem.sh/docs/glossary/terms#transaction-receipt). If the Transaction reverts, then the action will throw an error. - Docs: https://viem.sh/docs/actions/public/waitForTransactionReceipt - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/sending-transactions - JSON-RPC Methods: - Polls [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionReceipt) on each block until it has been processed. - If a Transaction has been replaced: - Calls [`eth_getBlockByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbynumber) and extracts the transactions - Checks if one of the Transactions is a replacement - If so, calls [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionReceipt). **`Remarks`** The `waitForTransactionReceipt` action additionally supports Replacement detection (e.g. sped up Transactions). Transactions can be replaced when a user modifies their transaction in their wallet (to speed up or cancel). Transactions are replaced when they are sent from the same nonce. There are 3 types of Transaction Replacement reasons: - `repriced`: The gas price has been modified (e.g. different `maxFeePerGas`) - `cancelled`: The Transaction has been cancelled (e.g. `value === 0n`) - `replaced`: The Transaction has been replaced (e.g. different `value` or `data`) **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transactionReceipt = await client.waitForTransactionReceipt({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ` | -| `client.watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | Watches and returns incoming block numbers. - Docs: https://viem.sh/docs/actions/public/watchBlockNumber - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/watching-blocks - JSON-RPC Methods: - When `poll: true`, calls [`eth_blockNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blocknumber) on a polling interval. - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newHeads"` event. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = await client.watchBlockNumber({ onBlockNumber: (blockNumber) => console.log(blockNumber), }) ` | -| `client.watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | Watches and returns information for incoming blocks. - Docs: https://viem.sh/docs/actions/public/watchBlocks - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/watching-blocks - JSON-RPC Methods: - When `poll: true`, calls [`eth_getBlockByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getBlockByNumber) on a polling interval. - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newHeads"` event. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = await client.watchBlocks({ onBlock: (block) => console.log(block), }) ` | -| `client.watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | Watches and returns emitted contract event logs. - Docs: https://viem.sh/docs/contract/watchContractEvent **`Remarks`** This Action will batch up all the event logs found within the [`pollingInterval`](https://viem.sh/docs/contract/watchContractEvent#pollinginterval-optional), and invoke them via [`onLogs`](https://viem.sh/docs/contract/watchContractEvent#onLogs). `watchContractEvent` will attempt to create an [Event Filter](https://viem.sh/docs/contract/createContractEventFilter) and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. `eth_newFilter`), then `watchContractEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs) instead. **`Example`** `ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = client.watchContractEvent({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['event Transfer(address indexed from, address indexed to, uint256 value)']), eventName: 'Transfer', args: { from: '0xc961145a54C96E3aE9bAA048c4F4D6b04C13916b' }, onLogs: (logs) => console.log(logs), }) ` | -| `client.watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | Watches and returns emitted [Event Logs](https://viem.sh/docs/glossary/terms#event-log). - Docs: https://viem.sh/docs/actions/public/watchEvent - JSON-RPC Methods: - **RPC Provider supports `eth_newFilter`:** - Calls [`eth_newFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newfilter) to create a filter (called on initialize). - On a polling interval, it will call [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterchanges). - **RPC Provider does not support `eth_newFilter`:** - Calls [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs) for each block between the polling interval. **`Remarks`** This Action will batch up all the Event Logs found within the [`pollingInterval`](https://viem.sh/docs/actions/public/watchEvent#pollinginterval-optional), and invoke them via [`onLogs`](https://viem.sh/docs/actions/public/watchEvent#onLogs). `watchEvent` will attempt to create an [Event Filter](https://viem.sh/docs/actions/public/createEventFilter) and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. `eth_newFilter`), then `watchEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs) instead. **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = client.watchEvent({ onLogs: (logs) => console.log(logs), }) ` | -| `client.watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | Watches and returns pending transaction hashes. - Docs: https://viem.sh/docs/actions/public/watchPendingTransactions - JSON-RPC Methods: - When `poll: true` - Calls [`eth_newPendingTransactionFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newpendingtransactionfilter) to initialize the filter. - Calls [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getFilterChanges) on a polling interval. - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newPendingTransactions"` event. **`Remarks`** This Action will batch up all the pending transactions found within the [`pollingInterval`](https://viem.sh/docs/actions/public/watchPendingTransactions#pollinginterval-optional), and invoke them via [`onTransactions`](https://viem.sh/docs/actions/public/watchPendingTransactions#ontransactions). **`Example`** `ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = await client.watchPendingTransactions({ onTransactions: (hashes) => console.log(hashes), }) ` | +| Name | Type | Description | +| :------ | :------ | :------ | +| `contractAddress` | `string` | the contract address | +| `client` | `Object` | the client to interact with the blockchain | +| `client.account` | `undefined` | The Account of the Client. | +| `client.batch?` | `Object` | Flags for batch settings. | +| `client.batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `client.cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `client.call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | Executes a new message call immediately without submitting a transaction to the network. - Docs: https://viem.sh/docs/actions/public/call - JSON-RPC Methods: [`eth_call`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_call) **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const data = await client.call({ account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', }) ``` | +| `client.ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `client.chain` | `undefined` \| `Chain` | Chain for the client. | +| `client.createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | Creates a Filter to listen for new block hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges). - Docs: https://viem.sh/docs/actions/public/createBlockFilter - JSON-RPC Methods: [`eth_newBlockFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newBlockFilter) **`Example`** ```ts import { createPublicClient, createBlockFilter, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await createBlockFilter(client) // { id: "0x345a6572337856574a76364e457a4366", type: 'block' } ``` | +| `client.createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges) or [`getFilterLogs`](https://viem.sh/docs/actions/public/getFilterLogs). - Docs: https://viem.sh/docs/contract/createContractEventFilter **`Example`** ```ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createContractEventFilter({ abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']), }) ``` | +| `client.createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | Creates a [`Filter`](https://viem.sh/docs/glossary/types#filter) to listen for new events that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges). - Docs: https://viem.sh/docs/actions/public/createEventFilter - JSON-RPC Methods: [`eth_newFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newfilter) **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createEventFilter({ address: '0xfba3912ca04dd458c843e2ee08967fc04f3579c2', }) ``` | +| `client.createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | Creates a Filter to listen for new pending transaction hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges). - Docs: https://viem.sh/docs/actions/public/createPendingTransactionFilter - JSON-RPC Methods: [`eth_newPendingTransactionFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newpendingtransactionfilter) **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createPendingTransactionFilter() // { id: "0x345a6572337856574a76364e457a4366", type: 'transaction' } ``` | +| `client.estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | Estimates the gas required to successfully execute a contract write function call. - Docs: https://viem.sh/docs/contract/estimateContractGas **`Remarks`** Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`estimateGas` action](https://viem.sh/docs/actions/public/estimateGas) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData). **`Example`** ```ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const gas = await client.estimateContractGas({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function mint() public']), functionName: 'mint', account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', }) ``` | +| `client.estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | Returns an estimate for the fees per gas for a transaction to be included in the next block. - Docs: https://viem.sh/docs/actions/public/estimateFeesPerGas **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const maxPriorityFeePerGas = await client.estimateFeesPerGas() // { maxFeePerGas: ..., maxPriorityFeePerGas: ... } ``` | +| `client.estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | Estimates the gas necessary to complete a transaction without submitting it to the network. - Docs: https://viem.sh/docs/actions/public/estimateGas - JSON-RPC Methods: [`eth_estimateGas`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_estimategas) **`Example`** ```ts import { createPublicClient, http, parseEther } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const gasEstimate = await client.estimateGas({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', value: parseEther('1'), }) ``` | +| `client.estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | Returns an estimate for the max priority fee per gas (in wei) for a transaction to be included in the next block. - Docs: https://viem.sh/docs/actions/public/estimateMaxPriorityFeePerGas **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const maxPriorityFeePerGas = await client.estimateMaxPriorityFeePerGas() // 10000000n ``` | +| `client.extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `client.getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | Returns the balance of an address in wei. - Docs: https://viem.sh/docs/actions/public/getBalance - JSON-RPC Methods: [`eth_getBalance`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getbalance) **`Remarks`** You can convert the balance to ether units with [`formatEther`](https://viem.sh/docs/utilities/formatEther). ```ts const balance = await getBalance(client, { address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', blockTag: 'safe' }) const balanceAsEther = formatEther(balance) // "6.942" ``` **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const balance = await client.getBalance({ address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', }) // 10000000000000000000000n (wei) ``` | +| `client.getBlobBaseFee` | () => `Promise`\<`bigint`\> | Returns the base fee per blob gas in wei. - Docs: https://viem.sh/docs/actions/public/getBlobBaseFee - JSON-RPC Methods: [`eth_blobBaseFee`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blobBaseFee) **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { getBlobBaseFee } from 'viem/public' const client = createPublicClient({ chain: mainnet, transport: http(), }) const blobBaseFee = await client.getBlobBaseFee() ``` | +| `client.getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | Returns information about a block at a block number, hash, or tag. - Docs: https://viem.sh/docs/actions/public/getBlock - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/fetching-blocks - JSON-RPC Methods: - Calls [`eth_getBlockByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbynumber) for `blockNumber` & `blockTag`. - Calls [`eth_getBlockByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbyhash) for `blockHash`. **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const block = await client.getBlock() ``` | +| `client.getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | Returns the number of the most recent block seen. - Docs: https://viem.sh/docs/actions/public/getBlockNumber - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/fetching-blocks - JSON-RPC Methods: [`eth_blockNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blocknumber) **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const blockNumber = await client.getBlockNumber() // 69420n ``` | +| `client.getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | Returns the number of Transactions at a block number, hash, or tag. - Docs: https://viem.sh/docs/actions/public/getBlockTransactionCount - JSON-RPC Methods: - Calls [`eth_getBlockTransactionCountByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblocktransactioncountbynumber) for `blockNumber` & `blockTag`. - Calls [`eth_getBlockTransactionCountByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblocktransactioncountbyhash) for `blockHash`. **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const count = await client.getBlockTransactionCount() ``` | +| `client.getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | Retrieves the bytecode at an address. - Docs: https://viem.sh/docs/contract/getBytecode - JSON-RPC Methods: [`eth_getCode`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getcode) **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const code = await client.getBytecode({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', }) ``` | +| `client.getChainId` | () => `Promise`\<`number`\> | Returns the chain ID associated with the current network. - Docs: https://viem.sh/docs/actions/public/getChainId - JSON-RPC Methods: [`eth_chainId`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_chainid) **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const chainId = await client.getChainId() // 1 ``` | +| `client.getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | Returns a list of event logs emitted by a contract. - Docs: https://viem.sh/docs/actions/public/getContractEvents - JSON-RPC Methods: [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs) **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { wagmiAbi } from './abi' const client = createPublicClient({ chain: mainnet, transport: http(), }) const logs = await client.getContractEvents(client, { address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: wagmiAbi, eventName: 'Transfer' }) ``` | +| `client.getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | Gets address for ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsAddress - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const ensAddress = await client.getEnsAddress({ name: normalize('wevm.eth'), }) // '0xd2135CfB216b74109775236E36d4b433F1DF507B' ``` | +| `client.getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | Gets the avatar of an ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsAvatar - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls [`getEnsText`](https://viem.sh/docs/ens/actions/getEnsText) with `key` set to `'avatar'`. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const ensAvatar = await client.getEnsAvatar({ name: normalize('wevm.eth'), }) // 'https://ipfs.io/ipfs/Qma8mnp6xV3J2cRNf3mTth5C8nV11CAnceVinc3y8jSbio' ``` | +| `client.getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | Gets primary name for specified address. - Docs: https://viem.sh/docs/ens/actions/getEnsName - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `reverse(bytes)` on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name. **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const ensName = await client.getEnsName({ address: '0xd2135CfB216b74109775236E36d4b433F1DF507B', }) // 'wevm.eth' ``` | +| `client.getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | Gets resolver for ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsResolver - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `findResolver(bytes)` on ENS Universal Resolver Contract to retrieve the resolver of an ENS name. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const resolverAddress = await client.getEnsResolver({ name: normalize('wevm.eth'), }) // '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41' ``` | +| `client.getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | Gets a text record for specified ENS name. - Docs: https://viem.sh/docs/ens/actions/getEnsResolver - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens **`Remarks`** Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract. Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this. **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { normalize } from 'viem/ens' const client = createPublicClient({ chain: mainnet, transport: http(), }) const twitterRecord = await client.getEnsText({ name: normalize('wevm.eth'), key: 'com.twitter', }) // 'wagmi_sh' ``` | +| `client.getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | Returns a collection of historical gas information. - Docs: https://viem.sh/docs/actions/public/getFeeHistory - JSON-RPC Methods: [`eth_feeHistory`](https://docs.alchemy.com/reference/eth-feehistory) **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const feeHistory = await client.getFeeHistory({ blockCount: 4, rewardPercentiles: [25, 75], }) ``` | +| `client.getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Returns a list of logs or hashes based on a [Filter](/docs/glossary/terms#filter) since the last time it was called. - Docs: https://viem.sh/docs/actions/public/getFilterChanges - JSON-RPC Methods: [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterchanges) **`Remarks`** A Filter can be created from the following actions: - [`createBlockFilter`](https://viem.sh/docs/actions/public/createBlockFilter) - [`createContractEventFilter`](https://viem.sh/docs/contract/createContractEventFilter) - [`createEventFilter`](https://viem.sh/docs/actions/public/createEventFilter) - [`createPendingTransactionFilter`](https://viem.sh/docs/actions/public/createPendingTransactionFilter) Depending on the type of filter, the return value will be different: - If the filter was created with `createContractEventFilter` or `createEventFilter`, it returns a list of logs. - If the filter was created with `createPendingTransactionFilter`, it returns a list of transaction hashes. - If the filter was created with `createBlockFilter`, it returns a list of block hashes. **`Example`** ```ts // Blocks import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createBlockFilter() const hashes = await client.getFilterChanges({ filter }) ``` **`Example`** ```ts // Contract Events import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createContractEventFilter({ address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']), eventName: 'Transfer', }) const logs = await client.getFilterChanges({ filter }) ``` **`Example`** ```ts // Raw Events import { createPublicClient, http, parseAbiItem } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createEventFilter({ address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', event: parseAbiItem('event Transfer(address indexed, address indexed, uint256)'), }) const logs = await client.getFilterChanges({ filter }) ``` **`Example`** ```ts // Transactions import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createPendingTransactionFilter() const hashes = await client.getFilterChanges({ filter }) ``` | +| `client.getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Returns a list of event logs since the filter was created. - Docs: https://viem.sh/docs/actions/public/getFilterLogs - JSON-RPC Methods: [`eth_getFilterLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterlogs) **`Remarks`** `getFilterLogs` is only compatible with **event filters**. **`Example`** ```ts import { createPublicClient, http, parseAbiItem } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const filter = await client.createEventFilter({ address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', event: parseAbiItem('event Transfer(address indexed, address indexed, uint256)'), }) const logs = await client.getFilterLogs({ filter }) ``` | +| `client.getGasPrice` | () => `Promise`\<`bigint`\> | Returns the current price of gas (in wei). - Docs: https://viem.sh/docs/actions/public/getGasPrice - JSON-RPC Methods: [`eth_gasPrice`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gasprice) **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const gasPrice = await client.getGasPrice() ``` | +| `client.getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | Returns a list of event logs matching the provided parameters. - Docs: https://viem.sh/docs/actions/public/getLogs - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/filters-and-logs/event-logs - JSON-RPC Methods: [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs) **`Example`** ```ts import { createPublicClient, http, parseAbiItem } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const logs = await client.getLogs() ``` | +| `client.getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | Returns the account and storage values of the specified account including the Merkle-proof. - Docs: https://viem.sh/docs/actions/public/getProof - JSON-RPC Methods: - Calls [`eth_getProof`](https://eips.ethereum.org/EIPS/eip-1186) **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const block = await client.getProof({ address: '0x...', storageKeys: ['0x...'], }) ``` | +| `client.getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | Returns the value from a storage slot at a given address. - Docs: https://viem.sh/docs/contract/getStorageAt - JSON-RPC Methods: [`eth_getStorageAt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getstorageat) **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { getStorageAt } from 'viem/contract' const client = createPublicClient({ chain: mainnet, transport: http(), }) const code = await client.getStorageAt({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', slot: toHex(0), }) ``` | +| `client.getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | Returns information about a [Transaction](https://viem.sh/docs/glossary/terms#transaction) given a hash or block identifier. - Docs: https://viem.sh/docs/actions/public/getTransaction - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions - JSON-RPC Methods: [`eth_getTransactionByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionByHash) **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transaction = await client.getTransaction({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ``` | +| `client.getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | Returns the number of blocks passed (confirmations) since the transaction was processed on a block. - Docs: https://viem.sh/docs/actions/public/getTransactionConfirmations - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions - JSON-RPC Methods: [`eth_getTransactionConfirmations`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionConfirmations) **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const confirmations = await client.getTransactionConfirmations({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ``` | +| `client.getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | Returns the number of [Transactions](https://viem.sh/docs/glossary/terms#transaction) an Account has broadcast / sent. - Docs: https://viem.sh/docs/actions/public/getTransactionCount - JSON-RPC Methods: [`eth_getTransactionCount`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gettransactioncount) **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transactionCount = await client.getTransactionCount({ address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', }) ``` | +| `client.getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | Returns the [Transaction Receipt](https://viem.sh/docs/glossary/terms#transaction-receipt) given a [Transaction](https://viem.sh/docs/glossary/terms#transaction) hash. - Docs: https://viem.sh/docs/actions/public/getTransactionReceipt - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions - JSON-RPC Methods: [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionReceipt) **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transactionReceipt = await client.getTransactionReceipt({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ``` | +| `client.key` | `string` | A key for the client. | +| `client.multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | Similar to [`readContract`](https://viem.sh/docs/contract/readContract), but batches up multiple functions on a contract in a single RPC call via the [`multicall3` contract](https://github.com/mds1/multicall). - Docs: https://viem.sh/docs/contract/multicall **`Example`** ```ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const abi = parseAbi([ 'function balanceOf(address) view returns (uint256)', 'function totalSupply() view returns (uint256)', ]) const result = await client.multicall({ contracts: [ { address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi, functionName: 'balanceOf', args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'], }, { address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi, functionName: 'totalSupply', }, ], }) // [{ result: 424122n, status: 'success' }, { result: 1000000n, status: 'success' }] ``` | +| `client.name` | `string` | A name for the client. | +| `client.pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `client.prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | Prepares a transaction request for signing. - Docs: https://viem.sh/docs/actions/wallet/prepareTransactionRequest **`Example`** ```ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const request = await client.prepareTransactionRequest({ account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', to: '0x0000000000000000000000000000000000000000', value: 1n, }) ``` **`Example`** ```ts // Account Hoisting import { createWalletClient, http } from 'viem' import { privateKeyToAccount } from 'viem/accounts' import { mainnet } from 'viem/chains' const client = createWalletClient({ account: privateKeyToAccount('0x…'), chain: mainnet, transport: custom(window.ethereum), }) const request = await client.prepareTransactionRequest({ to: '0x0000000000000000000000000000000000000000', value: 1n, }) ``` | +| `client.readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | Calls a read-only function on a contract, and returns the response. - Docs: https://viem.sh/docs/contract/readContract - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/reading-contracts **`Remarks`** A "read-only" function (constant function) on a Solidity contract is denoted by a `view` or `pure` keyword. They can only read the state of the contract, and cannot make any changes to it. Since read-only methods do not change the state of the contract, they do not require any gas to be executed, and can be called by any user without the need to pay for gas. Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`call` action](https://viem.sh/docs/actions/public/call) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData). **`Example`** ```ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' import { readContract } from 'viem/contract' const client = createPublicClient({ chain: mainnet, transport: http(), }) const result = await client.readContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function balanceOf(address) view returns (uint256)']), functionName: 'balanceOf', args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'], }) // 424122n ``` | +| `client.request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `client.sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | Sends a **signed** transaction to the network - Docs: https://viem.sh/docs/actions/wallet/sendRawTransaction - JSON-RPC Method: [`eth_sendRawTransaction`](https://ethereum.github.io/execution-apis/api-documentation/) **`Example`** ```ts import { createWalletClient, custom } from 'viem' import { mainnet } from 'viem/chains' import { sendRawTransaction } from 'viem/wallet' const client = createWalletClient({ chain: mainnet, transport: custom(window.ethereum), }) const hash = await client.sendRawTransaction({ serializedTransaction: '0x02f850018203118080825208808080c080a04012522854168b27e5dc3d5839bab5e6b39e1a0ffd343901ce1622e3d64b48f1a04e00902ae0502c4728cbf12156290df99c3ed7de85b1dbfe20b5c36931733a33' }) ``` | +| `client.simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | Simulates/validates a contract interaction. This is useful for retrieving **return data** and **revert reasons** of contract write functions. - Docs: https://viem.sh/docs/contract/simulateContract - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/writing-to-contracts **`Remarks`** This function does not require gas to execute and _**does not**_ change the state of the blockchain. It is almost identical to [`readContract`](https://viem.sh/docs/contract/readContract), but also supports contract write functions. Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`call` action](https://viem.sh/docs/actions/public/call) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData). **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const result = await client.simulateContract({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['function mint(uint32) view returns (uint32)']), functionName: 'mint', args: ['69420'], account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', }) ``` | +| `client.transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `client.type` | `string` | The type of client. | +| `client.uid` | `string` | A unique ID for the client. | +| `client.uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | Destroys a Filter that was created from one of the following Actions: - [`createBlockFilter`](https://viem.sh/docs/actions/public/createBlockFilter) - [`createEventFilter`](https://viem.sh/docs/actions/public/createEventFilter) - [`createPendingTransactionFilter`](https://viem.sh/docs/actions/public/createPendingTransactionFilter) - Docs: https://viem.sh/docs/actions/public/uninstallFilter - JSON-RPC Methods: [`eth_uninstallFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_uninstallFilter) **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' import { createPendingTransactionFilter, uninstallFilter } from 'viem/public' const filter = await client.createPendingTransactionFilter() const uninstalled = await client.uninstallFilter({ filter }) // true ``` | +| `client.verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `client.verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `client.waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | Waits for the [Transaction](https://viem.sh/docs/glossary/terms#transaction) to be included on a [Block](https://viem.sh/docs/glossary/terms#block) (one confirmation), and then returns the [Transaction Receipt](https://viem.sh/docs/glossary/terms#transaction-receipt). If the Transaction reverts, then the action will throw an error. - Docs: https://viem.sh/docs/actions/public/waitForTransactionReceipt - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/sending-transactions - JSON-RPC Methods: - Polls [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionReceipt) on each block until it has been processed. - If a Transaction has been replaced: - Calls [`eth_getBlockByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbynumber) and extracts the transactions - Checks if one of the Transactions is a replacement - If so, calls [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionReceipt). **`Remarks`** The `waitForTransactionReceipt` action additionally supports Replacement detection (e.g. sped up Transactions). Transactions can be replaced when a user modifies their transaction in their wallet (to speed up or cancel). Transactions are replaced when they are sent from the same nonce. There are 3 types of Transaction Replacement reasons: - `repriced`: The gas price has been modified (e.g. different `maxFeePerGas`) - `cancelled`: The Transaction has been cancelled (e.g. `value === 0n`) - `replaced`: The Transaction has been replaced (e.g. different `value` or `data`) **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const transactionReceipt = await client.waitForTransactionReceipt({ hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', }) ``` | +| `client.watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | Watches and returns incoming block numbers. - Docs: https://viem.sh/docs/actions/public/watchBlockNumber - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/watching-blocks - JSON-RPC Methods: - When `poll: true`, calls [`eth_blockNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blocknumber) on a polling interval. - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newHeads"` event. **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = await client.watchBlockNumber({ onBlockNumber: (blockNumber) => console.log(blockNumber), }) ``` | +| `client.watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | Watches and returns information for incoming blocks. - Docs: https://viem.sh/docs/actions/public/watchBlocks - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/watching-blocks - JSON-RPC Methods: - When `poll: true`, calls [`eth_getBlockByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getBlockByNumber) on a polling interval. - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newHeads"` event. **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = await client.watchBlocks({ onBlock: (block) => console.log(block), }) ``` | +| `client.watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | Watches and returns emitted contract event logs. - Docs: https://viem.sh/docs/contract/watchContractEvent **`Remarks`** This Action will batch up all the event logs found within the [`pollingInterval`](https://viem.sh/docs/contract/watchContractEvent#pollinginterval-optional), and invoke them via [`onLogs`](https://viem.sh/docs/contract/watchContractEvent#onLogs). `watchContractEvent` will attempt to create an [Event Filter](https://viem.sh/docs/contract/createContractEventFilter) and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. `eth_newFilter`), then `watchContractEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs) instead. **`Example`** ```ts import { createPublicClient, http, parseAbi } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = client.watchContractEvent({ address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', abi: parseAbi(['event Transfer(address indexed from, address indexed to, uint256 value)']), eventName: 'Transfer', args: { from: '0xc961145a54C96E3aE9bAA048c4F4D6b04C13916b' }, onLogs: (logs) => console.log(logs), }) ``` | +| `client.watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | Watches and returns emitted [Event Logs](https://viem.sh/docs/glossary/terms#event-log). - Docs: https://viem.sh/docs/actions/public/watchEvent - JSON-RPC Methods: - **RPC Provider supports `eth_newFilter`:** - Calls [`eth_newFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newfilter) to create a filter (called on initialize). - On a polling interval, it will call [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterchanges). - **RPC Provider does not support `eth_newFilter`:** - Calls [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs) for each block between the polling interval. **`Remarks`** This Action will batch up all the Event Logs found within the [`pollingInterval`](https://viem.sh/docs/actions/public/watchEvent#pollinginterval-optional), and invoke them via [`onLogs`](https://viem.sh/docs/actions/public/watchEvent#onLogs). `watchEvent` will attempt to create an [Event Filter](https://viem.sh/docs/actions/public/createEventFilter) and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. `eth_newFilter`), then `watchEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs) instead. **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = client.watchEvent({ onLogs: (logs) => console.log(logs), }) ``` | +| `client.watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | Watches and returns pending transaction hashes. - Docs: https://viem.sh/docs/actions/public/watchPendingTransactions - JSON-RPC Methods: - When `poll: true` - Calls [`eth_newPendingTransactionFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newpendingtransactionfilter) to initialize the filter. - Calls [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getFilterChanges) on a polling interval. - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newPendingTransactions"` event. **`Remarks`** This Action will batch up all the pending transactions found within the [`pollingInterval`](https://viem.sh/docs/actions/public/watchPendingTransactions#pollinginterval-optional), and invoke them via [`onTransactions`](https://viem.sh/docs/actions/public/watchPendingTransactions#ontransactions). **`Example`** ```ts import { createPublicClient, http } from 'viem' import { mainnet } from 'viem/chains' const client = createPublicClient({ chain: mainnet, transport: http(), }) const unwatch = await client.watchPendingTransactions({ onTransactions: (hashes) => console.log(hashes), }) ``` | #### Returns @@ -768,35 +768,35 @@ true if the contract exists and false otherwise #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:213](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L213) +[src/nevermined/utils/BlockchainViemUtils.ts:213](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L213) ---- +___ ### createKernelClient -▸ **createKernelClient**(`signer`, `chainId`, `zeroDevProjectId`): `Promise`\<`KernelAccountClient`\<`"0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789"`, `Transport`, `Chain`, `any`\>\> +▸ **createKernelClient**(`signer`, `chainId`, `zeroDevProjectId`): `Promise`\<`KernelAccountClient`\<``"0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789"``, `Transport`, `Chain`, `any`\>\> It creates a ZeroDev Kernel client. #### Parameters -| Name | Type | Description | -| :----------------- | :------- | :----------------------------------------------------------------- | -| `signer` | `any` | the signer account | -| `chainId` | `number` | the chain id | +| Name | Type | Description | +| :------ | :------ | :------ | +| `signer` | `any` | the signer account | +| `chainId` | `number` | the chain id | | `zeroDevProjectId` | `string` | the zero dev project id, you can get it from the ZeroDev dashboard | #### Returns -`Promise`\<`KernelAccountClient`\<`"0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789"`, `Transport`, `Chain`, `any`\>\> +`Promise`\<`KernelAccountClient`\<``"0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789"``, `Transport`, `Chain`, `any`\>\> the kernel client #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:533](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L533) +[src/nevermined/utils/BlockchainViemUtils.ts:533](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L533) ---- +___ ### createSessionKey @@ -806,11 +806,11 @@ It creates a ZeroDev Session Key with some specific permissions #### Parameters -| Name | Type | Description | -| :------------- | :------ | :---------------------------------------------- | -| `signer` | `any` | the signer account | -| `publicClient` | `any` | the blockchain client | -| `permissions` | `any`[] | the permissions to configure in the session key | +| Name | Type | Description | +| :------ | :------ | :------ | +| `signer` | `any` | the signer account | +| `publicClient` | `any` | the blockchain client | +| `permissions` | `any`[] | the permissions to configure in the session key | #### Returns @@ -820,9 +820,9 @@ the session key serialized #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:581](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L581) +[src/nevermined/utils/BlockchainViemUtils.ts:581](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L581) ---- +___ ### decryptMessage @@ -830,10 +830,10 @@ the session key serialized #### Parameters -| Name | Type | -| :----------------- | :------- | +| Name | Type | +| :------ | :------ | | `encryptedMessage` | `string` | -| `privateKey` | `any` | +| `privateKey` | `any` | #### Returns @@ -841,39 +841,39 @@ the session key serialized #### Defined in -[src/common/helpers.ts:81](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/common/helpers.ts#L81) +[src/common/helpers.ts:81](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/common/helpers.ts#L81) ---- +___ ### deployContractInstance -▸ **deployContractInstance**(`artifact`, `from`, `args?`, `client`): `Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> +▸ **deployContractInstance**(`artifact`, `from`, `args?`, `client`): `Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> Given an artifact, it deploys the contract and returns the contract instance. #### Parameters -| Name | Type | Default value | Description | -| :------------------ | :----------------------------------------- | :------------ | :---------------------------------------------------------------- | -| `artifact` | `Object` | `undefined` | the contract artifact | -| `artifact.abi` | `Abi` | `undefined` | - | -| `artifact.bytecode` | \`0x$\{string}\` | `undefined` | - | -| `artifact.name?` | `string` | `undefined` | - | -| `from` | [`NvmAccount`](classes/NvmAccount.md) | `undefined` | the deployer account | -| `args` | `string`[] | `[]` | parameters to be passed to the contract during the initialization | -| `client` | [`Web3Clients`](interfaces/Web3Clients.md) | `undefined` | the client to interact with the blockchain | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `artifact` | `Object` | `undefined` | the contract artifact | +| `artifact.abi` | `Abi` | `undefined` | - | +| `artifact.bytecode` | \`0x$\{string}\` | `undefined` | - | +| `artifact.name?` | `string` | `undefined` | - | +| `from` | [`NvmAccount`](classes/NvmAccount.md) | `undefined` | the deployer account | +| `args` | `string`[] | `[]` | parameters to be passed to the contract during the initialization | +| `client` | [`Web3Clients`](interfaces/Web3Clients.md) | `undefined` | the client to interact with the blockchain | #### Returns -`Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> +`Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> a contract instance #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:150](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L150) +[src/nevermined/utils/BlockchainViemUtils.ts:150](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L150) ---- +___ ### deserializeECIES @@ -881,26 +881,26 @@ a contract instance #### Parameters -| Name | Type | -| :----------- | :---- | +| Name | Type | +| :------ | :------ | | `serialized` | `any` | #### Returns `Object` -| Name | Type | -| :--------------- | :------- | -| `ciphertext` | `Buffer` | +| Name | Type | +| :------ | :------ | +| `ciphertext` | `Buffer` | | `ephemPublicKey` | `Buffer` | -| `iv` | `Buffer` | -| `mac` | `Buffer` | +| `iv` | `Buffer` | +| `mac` | `Buffer` | #### Defined in -[src/common/helpers.ts:99](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/common/helpers.ts#L99) +[src/common/helpers.ts:99](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/common/helpers.ts#L99) ---- +___ ### didPrefixed @@ -908,8 +908,8 @@ a contract instance #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `input` | `string` | #### Returns @@ -918,9 +918,9 @@ a contract instance #### Defined in -[src/utils/ConversionTypeHelpers.ts:13](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/ConversionTypeHelpers.ts#L13) +[src/utils/ConversionTypeHelpers.ts:13](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/ConversionTypeHelpers.ts#L13) ---- +___ ### didToTokenId @@ -931,8 +931,8 @@ This is useful because in the Solidity Smart contracts the tokenId is a uint256. #### Parameters -| Name | Type | Description | -| :---- | :------- | :--------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `did` | `string` | the unique identifier of the asset | #### Returns @@ -943,9 +943,9 @@ the token id in a bigint format #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:320](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L320) +[src/nevermined/utils/BlockchainViemUtils.ts:320](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L320) ---- +___ ### didTransformer @@ -953,10 +953,10 @@ the token id in a bigint format #### Parameters -| Name | Type | Default value | -| :------------- | :-------- | :------------ | -| `input` | `string` | `''` | -| `prefixOutput` | `boolean` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `input` | `string` | `''` | +| `prefixOutput` | `boolean` | `undefined` | #### Returns @@ -964,9 +964,9 @@ the token id in a bigint format #### Defined in -[src/utils/ConversionTypeHelpers.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/ConversionTypeHelpers.ts#L16) +[src/utils/ConversionTypeHelpers.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/ConversionTypeHelpers.ts#L16) ---- +___ ### didZeroX @@ -974,8 +974,8 @@ the token id in a bigint format #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `input` | `string` | #### Returns @@ -984,9 +984,9 @@ the token id in a bigint format #### Defined in -[src/utils/ConversionTypeHelpers.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/ConversionTypeHelpers.ts#L22) +[src/utils/ConversionTypeHelpers.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/ConversionTypeHelpers.ts#L22) ---- +___ ### encodeBytes32String @@ -996,8 +996,8 @@ Encodes a UTF-8 string into a hex string #### Parameters -| Name | Type | Description | -| :-------- | :------- | :------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `message` | `string` | the string to encode | #### Returns @@ -1008,9 +1008,9 @@ the hex string #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:367](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L367) +[src/nevermined/utils/BlockchainViemUtils.ts:367](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L367) ---- +___ ### encryptMessage @@ -1018,9 +1018,9 @@ the hex string #### Parameters -| Name | Type | -| :------------------ | :------- | -| `message` | `string` | +| Name | Type | +| :------ | :------ | +| `message` | `string` | | `receiverPublicKey` | `string` | #### Returns @@ -1029,9 +1029,9 @@ the hex string #### Defined in -[src/common/helpers.ts:74](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/common/helpers.ts#L74) +[src/common/helpers.ts:74](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/common/helpers.ts#L74) ---- +___ ### eventToObject @@ -1039,8 +1039,8 @@ the hex string #### Parameters -| Name | Type | -| :------ | :---- | +| Name | Type | +| :------ | :------ | | `event` | `any` | #### Returns @@ -1049,9 +1049,9 @@ the hex string #### Defined in -[src/utils/Events.ts:1](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/Events.ts#L1) +[src/utils/Events.ts:1](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/Events.ts#L1) ---- +___ ### formatEther @@ -1061,8 +1061,8 @@ Converts a _wei_ value into _ether_. #### Parameters -| Name | Type | Description | -| :------ | :------- | :------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `value` | `bigint` | The value to format. | #### Returns @@ -1082,9 +1082,9 @@ formatEther(value) #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:520](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L520) +[src/nevermined/utils/BlockchainViemUtils.ts:520](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L520) ---- +___ ### formatUnits @@ -1094,10 +1094,10 @@ Returns a string representation of value formatted with _decimal_ digits. #### Parameters -| Name | Type | Default value | Description | -| :--------- | :------- | :------------ | :------------------- | -| `value` | `bigint` | `undefined` | The value to format. | -| `decimals` | `number` | `18` | - | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `value` | `bigint` | `undefined` | The value to format. | +| `decimals` | `number` | `18` | - | #### Returns @@ -1116,9 +1116,9 @@ formatUnits(oneEther, 18) #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:483](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L483) +[src/nevermined/utils/BlockchainViemUtils.ts:483](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L483) ---- +___ ### generateId @@ -1126,9 +1126,9 @@ formatUnits(oneEther, 18) #### Parameters -| Name | Type | Default value | -| :------- | :------- | :------------ | -| `length` | `number` | `64` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `length` | `number` | `64` | #### Returns @@ -1136,9 +1136,9 @@ formatUnits(oneEther, 18) #### Defined in -[src/common/helpers.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/common/helpers.ts#L39) +[src/common/helpers.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/common/helpers.ts#L39) ---- +___ ### generateInstantiableConfigFromConfig @@ -1146,10 +1146,10 @@ formatUnits(oneEther, 18) #### Parameters -| Name | Type | Default value | -| :--------- | :-------------------------------------------------- | :------------ | -| `config` | [`NeverminedOptions`](classes/NeverminedOptions.md) | `undefined` | -| `loadCore` | `boolean` | `true` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`NeverminedOptions`](classes/NeverminedOptions.md) | `undefined` | +| `loadCore` | `boolean` | `true` | #### Returns @@ -1157,9 +1157,9 @@ formatUnits(oneEther, 18) #### Defined in -[src/Instantiable.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L29) +[src/Instantiable.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L29) ---- +___ ### getBytes @@ -1169,8 +1169,8 @@ Encodes a UTF-8 string into a byte array. #### Parameters -| Name | Type | Description | -| :-------- | :------- | :------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `message` | `string` | the string to encode | #### Returns @@ -1181,9 +1181,9 @@ the encoded byte array #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:348](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L348) +[src/nevermined/utils/BlockchainViemUtils.ts:348](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L348) ---- +___ ### getChain @@ -1191,8 +1191,8 @@ the encoded byte array #### Parameters -| Name | Type | -| :---------- | :---------------------- | +| Name | Type | +| :------ | :------ | | `networkId` | `undefined` \| `number` | #### Returns @@ -1201,9 +1201,9 @@ the encoded byte array #### Defined in -[src/utils/Network.ts:148](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/Network.ts#L148) +[src/utils/Network.ts:148](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/Network.ts#L148) ---- +___ ### getChecksumAddress @@ -1213,8 +1213,8 @@ Given an address it returns that address in checksum format. #### Parameters -| Name | Type | Description | -| :-------- | :------- | :---------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `address` | `string` | the address | #### Returns @@ -1225,9 +1225,9 @@ the same address in checksum format #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:329](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L329) +[src/nevermined/utils/BlockchainViemUtils.ts:329](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L329) ---- +___ ### getCircularReplacer @@ -1241,9 +1241,9 @@ the same address in checksum format ##### Parameters -| Name | Type | -| :------ | :---- | -| `_key` | `any` | +| Name | Type | +| :------ | :------ | +| `_key` | `any` | | `value` | `any` | ##### Returns @@ -1252,9 +1252,9 @@ the same address in checksum format #### Defined in -[src/common/helpers.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/common/helpers.ts#L21) +[src/common/helpers.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/common/helpers.ts#L21) ---- +___ ### getConditionsByParams @@ -1264,22 +1264,22 @@ Fill some static parameters that depends on the metadata. #### Parameters -| Name | Type | Default value | Description | -| :---------------------- | :------------------------------------------------------------------------------------------------ | :------------ | :-------------------------------------------------------------------------------------- | -| `serviceType` | [`ServiceType`](code-reference.md#servicetype) | `undefined` | The type of the service "access", "nft-sales", etc. | -| `conditions` | readonly [`ServiceAgreementTemplateCondition`](interfaces/ServiceAgreementTemplateCondition.md)[] | `undefined` | List of conditions to fill. | -| `owner` | `string` | `undefined` | Owner of the asset. | -| `assetPrice` | [`AssetPrice`](classes/AssetPrice.md) | `undefined` | Rewards distribution | -| `did?` | `string` | `undefined` | The DID of the asset. | -| `erc20TokenContract?` | `string` | `undefined` | The address of the ERC20 token contract used for payment (0x0 address if native token). | -| `nftTokenContract?` | `string` | `undefined` | The address of the NFT token contract used. | -| `nftHolder?` | `string` | `undefined` | The address of the NFT holder. | -| `nftAmount` | `bigint` | `undefined` | Number of nfts to handle | -| `nftTransfer` | `boolean` | `false` | If the nft will be transferred (true) or minted (false) | -| `duration` | `number` | `0` | Duration if it's a subscription | -| `fulfillAccessTimeout` | `number` | `0` | Timeout for the fulfill of the access service | -| `fulfillAccessTimelock` | `number` | `0` | Timelock for the fulfill of the access service | -| `tokenId` | `string` | `''` | The token id of the NFT | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `serviceType` | [`ServiceType`](code-reference.md#servicetype) | `undefined` | The type of the service "access", "nft-sales", etc. | +| `conditions` | readonly [`ServiceAgreementTemplateCondition`](interfaces/ServiceAgreementTemplateCondition.md)[] | `undefined` | List of conditions to fill. | +| `owner` | `string` | `undefined` | Owner of the asset. | +| `assetPrice` | [`AssetPrice`](classes/AssetPrice.md) | `undefined` | Rewards distribution | +| `did?` | `string` | `undefined` | The DID of the asset. | +| `erc20TokenContract?` | `string` | `undefined` | The address of the ERC20 token contract used for payment (0x0 address if native token). | +| `nftTokenContract?` | `string` | `undefined` | The address of the NFT token contract used. | +| `nftHolder?` | `string` | `undefined` | The address of the NFT holder. | +| `nftAmount` | `bigint` | `undefined` | Number of nfts to handle | +| `nftTransfer` | `boolean` | `false` | If the nft will be transferred (true) or minted (false) | +| `duration` | `number` | `0` | Duration if it's a subscription | +| `fulfillAccessTimeout` | `number` | `0` | Timeout for the fulfill of the access service | +| `fulfillAccessTimelock` | `number` | `0` | Timelock for the fulfill of the access service | +| `tokenId` | `string` | `''` | The token id of the NFT | #### Returns @@ -1289,35 +1289,35 @@ Filled conditions. #### Defined in -[src/ddo/DDO.ts:58](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/ddo/DDO.ts#L58) +[src/ddo/DDO.ts:58](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/ddo/DDO.ts#L58) ---- +___ ### getContractInstance -▸ **getContractInstance**(`contractAddress`, `abi`, `client`): `Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> +▸ **getContractInstance**(`contractAddress`, `abi`, `client`): `Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> Given an already deployed contract address and the ABI, it returns the contract instance. #### Parameters -| Name | Type | Description | -| :---------------- | :----------------------------------------- | :----------------------------------------- | -| `contractAddress` | `string` | the contract address | -| `abi` | `Abi` | the contract artifact | -| `client` | [`Web3Clients`](interfaces/Web3Clients.md) | the client to interact with the blockchain | +| Name | Type | Description | +| :------ | :------ | :------ | +| `contractAddress` | `string` | the contract address | +| `abi` | `Abi` | the contract artifact | +| `client` | [`Web3Clients`](interfaces/Web3Clients.md) | the client to interact with the blockchain | #### Returns -`Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> +`Promise`\<\{ `abi`: `Abi` ; `address`: \`0x$\{string}\` ; `createEventFilter`: {} ; `estimateGas`: {} & {} ; `getEvents`: {} ; `read`: {} ; `simulate`: {} ; `watchEvent`: {} ; `write`: {} }\> a contract instance #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:199](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L199) +[src/nevermined/utils/BlockchainViemUtils.ts:199](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L199) ---- +___ ### getInputsOfFunction @@ -1327,11 +1327,11 @@ It searchs an ABI function in the ABI and return the inputs. #### Parameters -| Name | Type | Default value | Description | -| :--------- | :------- | :------------ | :----------------------- | -| `abi` | `Abi` | `undefined` | the ABI of the contract | -| `funcName` | `string` | `undefined` | the function name | -| `args` | `any`[] | `[]` | the args of the function | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `abi` | `Abi` | `undefined` | the ABI of the contract | +| `funcName` | `string` | `undefined` | the function name | +| `args` | `any`[] | `[]` | the args of the function | #### Returns @@ -1341,35 +1341,35 @@ the function found #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:292](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L292) +[src/nevermined/utils/BlockchainViemUtils.ts:292](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L292) ---- +___ ### getInputsOfFunctionFormatted -▸ **getInputsOfFunctionFormatted**(`abi`, `funcName`, `args?`): \{ `name`: `undefined` \| `string` = input.name; `value`: `any` }[] +▸ **getInputsOfFunctionFormatted**(`abi`, `funcName`, `args?`): \{ `name`: `undefined` \| `string` = input.name; `value`: `any` }[] It searchs an ABI function in the ABI and return the inputs formatted. #### Parameters -| Name | Type | Default value | Description | -| :--------- | :------- | :------------ | :----------------------- | -| `abi` | `Abi` | `undefined` | the ABI of the contract | -| `funcName` | `string` | `undefined` | the function name | -| `args` | `any`[] | `[]` | the args of the function | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `abi` | `Abi` | `undefined` | the ABI of the contract | +| `funcName` | `string` | `undefined` | the function name | +| `args` | `any`[] | `[]` | the args of the function | #### Returns -\{ `name`: `undefined` \| `string` = input.name; `value`: `any` }[] +\{ `name`: `undefined` \| `string` = input.name; `value`: `any` }[] the function found #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:303](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L303) +[src/nevermined/utils/BlockchainViemUtils.ts:303](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L303) ---- +___ ### getNetworkName @@ -1377,8 +1377,8 @@ the function found #### Parameters -| Name | Type | -| :---------- | :------- | +| Name | Type | +| :------ | :------ | | `networkId` | `number` | #### Returns @@ -1387,9 +1387,9 @@ the function found #### Defined in -[src/utils/Network.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/Network.ts#L19) +[src/utils/Network.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/Network.ts#L19) ---- +___ ### getRoyaltyAttributes @@ -1399,11 +1399,11 @@ It gets a `RoyaltyAttributes` instance #### Parameters -| Name | Type | Description | -| :------- | :------------------------------------ | :----------------------------------------------------- | -| `nvm` | [`Nevermined`](classes/Nevermined.md) | Nevermined instance | -| `kind` | [`RoyaltyKind`](enums/RoyaltyKind.md) | The type of royalty | -| `amount` | `number` | The amount of royalties to get in the secondary market | +| Name | Type | Description | +| :------ | :------ | :------ | +| `nvm` | [`Nevermined`](classes/Nevermined.md) | Nevermined instance | +| `kind` | [`RoyaltyKind`](enums/RoyaltyKind.md) | The type of royalty | +| `amount` | `number` | The amount of royalties to get in the secondary market | #### Returns @@ -1413,9 +1413,9 @@ The RoyaltyAttributes instance #### Defined in -[src/nevermined/api/AssetsApi.ts:62](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L62) +[src/nevermined/api/AssetsApi.ts:62](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L62) ---- +___ ### getRoyaltyScheme @@ -1425,9 +1425,9 @@ It gets the on-chain royalties scheme #### Parameters -| Name | Type | Description | -| :----- | :------------------------------------ | :------------------ | -| `nvm` | [`Nevermined`](classes/Nevermined.md) | Nevermined instance | +| Name | Type | Description | +| :------ | :------ | :------ | +| `nvm` | [`Nevermined`](classes/Nevermined.md) | Nevermined instance | | `kind` | [`RoyaltyKind`](enums/RoyaltyKind.md) | The type of royalty | #### Returns @@ -1438,9 +1438,9 @@ The royalty scheme #### Defined in -[src/nevermined/api/AssetsApi.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L47) +[src/nevermined/api/AssetsApi.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L47) ---- +___ ### getSessionKey @@ -1450,11 +1450,11 @@ Given a serialized session key it reconstructs the NvmAccount represented by the #### Parameters -| Name | Type | Description | -| :--------------------- | :------- | :------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `serializedSessionKey` | `string` | the serialized session key | -| `zeroDevProjectId` | `string` | the zero dev project id | -| `publicClient` | `any` | the blockchain client | +| `zeroDevProjectId` | `string` | the zero dev project id | +| `publicClient` | `any` | the blockchain client | #### Returns @@ -1464,9 +1464,9 @@ the NvmAccount represented by the session key #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:616](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L616) +[src/nevermined/utils/BlockchainViemUtils.ts:616](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L616) ---- +___ ### getSignatureOfFunction @@ -1476,11 +1476,11 @@ It searchs an ABI function in the ABI. #### Parameters -| Name | Type | Default value | Description | -| :--------- | :------- | :------------ | :----------------------- | -| `abi` | `Abi` | `undefined` | the ABI of the contract | -| `funcName` | `string` | `undefined` | the function name | -| `args` | `any`[] | `[]` | the args of the function | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `abi` | `Abi` | `undefined` | the ABI of the contract | +| `funcName` | `string` | `undefined` | the function name | +| `args` | `any`[] | `[]` | the args of the function | #### Returns @@ -1490,9 +1490,9 @@ the function found #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:281](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L281) +[src/nevermined/utils/BlockchainViemUtils.ts:281](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L281) ---- +___ ### getWeb3ViemClients @@ -1500,8 +1500,8 @@ the function found #### Parameters -| Name | Type | -| :------- | :--------------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | `Partial`\<[`NeverminedOptions`](classes/NeverminedOptions.md)\> | #### Returns @@ -1510,9 +1510,9 @@ the function found #### Defined in -[src/Instantiable.abstract.ts:49](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L49) +[src/Instantiable.abstract.ts:49](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L49) ---- +___ ### isTestnet @@ -1520,8 +1520,8 @@ the function found #### Parameters -| Name | Type | -| :---------- | :------- | +| Name | Type | +| :------ | :------ | | `networkId` | `number` | #### Returns @@ -1530,9 +1530,9 @@ the function found #### Defined in -[src/utils/Network.ts:83](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/Network.ts#L83) +[src/utils/Network.ts:83](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/Network.ts#L83) ---- +___ ### isValidAddress @@ -1542,8 +1542,8 @@ It checks if the address is a valid address. #### Parameters -| Name | Type | Description | -| :-------- | :------- | :------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `address` | `string` | the address to check | #### Returns @@ -1554,9 +1554,9 @@ true of the address is valid #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:338](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L338) +[src/nevermined/utils/BlockchainViemUtils.ts:338](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L338) ---- +___ ### jsonReplacer @@ -1564,9 +1564,9 @@ true of the address is valid #### Parameters -| Name | Type | -| :------ | :---- | -| `_key` | `any` | +| Name | Type | +| :------ | :------ | +| `_key` | `any` | | `value` | `any` | #### Returns @@ -1575,9 +1575,9 @@ true of the address is valid #### Defined in -[src/common/helpers.ts:34](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/common/helpers.ts#L34) +[src/common/helpers.ts:34](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/common/helpers.ts#L34) ---- +___ ### keccak256 @@ -1587,8 +1587,8 @@ It hashes a string using keccak256. #### Parameters -| Name | Type | Description | -| :----- | :------- | :----------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `seed` | `string` | the string to hash | #### Returns @@ -1599,9 +1599,9 @@ the hash #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:422](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L422) +[src/nevermined/utils/BlockchainViemUtils.ts:422](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L422) ---- +___ ### keccak256Packed @@ -1611,10 +1611,10 @@ It encodes and hashes a list of primitive values into an ABI-encoded hex value. #### Parameters -| Name | Type | Description | -| :------- | :------ | :---------------------- | -| `types` | `any`[] | the types of the values | -| `values` | `any`[] | the values to encode | +| Name | Type | Description | +| :------ | :------ | :------ | +| `types` | `any`[] | the types of the values | +| `values` | `any`[] | the values to encode | #### Returns @@ -1624,9 +1624,9 @@ the hash #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:443](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L443) +[src/nevermined/utils/BlockchainViemUtils.ts:443](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L443) ---- +___ ### keccak256WithEncode @@ -1636,10 +1636,10 @@ It encodes and hashes a list of primitive values into an ABI-encoded hex value. #### Parameters -| Name | Type | Description | -| :------- | :------ | :---------------------- | -| `types` | `any`[] | the types of the values | -| `values` | `any`[] | the values to encode | +| Name | Type | Description | +| :------ | :------ | :------ | +| `types` | `any`[] | the types of the values | +| `values` | `any`[] | the values to encode | #### Returns @@ -1649,9 +1649,9 @@ the hash #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:432](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L432) +[src/nevermined/utils/BlockchainViemUtils.ts:432](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L432) ---- +___ ### makeRandomWallet @@ -1667,9 +1667,9 @@ a new account #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:400](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L400) +[src/nevermined/utils/BlockchainViemUtils.ts:400](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L400) ---- +___ ### makeRandomWallets @@ -1679,9 +1679,9 @@ It generates a list of random accounts #### Parameters -| Name | Type | Default value | Description | -| :------------ | :------- | :------------ | :------------------------------- | -| `numAccounts` | `number` | `10` | the number of accounts to create | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `numAccounts` | `number` | `10` | the number of accounts to create | #### Returns @@ -1691,9 +1691,9 @@ the array of accounts #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:410](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L410) +[src/nevermined/utils/BlockchainViemUtils.ts:410](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L410) ---- +___ ### makeWallet @@ -1703,10 +1703,10 @@ Given a seedphrase, it returns an account. #### Parameters -| Name | Type | Default value | Description | -| :------------- | :------- | :------------ | :------------------------------------------------ | -| `seedphrase` | `string` | `undefined` | the seedphrase to be used to generate the account | -| `addressIndex` | `number` | `0` | the address index | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `seedphrase` | `string` | `undefined` | the seedphrase to be used to generate the account | +| `addressIndex` | `number` | `0` | the address index | #### Returns @@ -1716,9 +1716,9 @@ an account #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:378](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L378) +[src/nevermined/utils/BlockchainViemUtils.ts:378](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L378) ---- +___ ### makeWallets @@ -1728,10 +1728,10 @@ Given a seedphrase generates multiple accounts #### Parameters -| Name | Type | Default value | Description | -| :------------ | :------- | :------------ | :------------------------------------------------ | -| `seedphrase` | `string` | `undefined` | the seedphrase to be used to generate the account | -| `numAccounts` | `number` | `10` | the number of accounts to create | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `seedphrase` | `string` | `undefined` | the seedphrase to be used to generate the account | +| `numAccounts` | `number` | `10` | the number of accounts to create | #### Returns @@ -1741,9 +1741,9 @@ the array of accounts #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:388](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L388) +[src/nevermined/utils/BlockchainViemUtils.ts:388](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L388) ---- +___ ### noDidPrefixed @@ -1751,8 +1751,8 @@ the array of accounts #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `input` | `string` | #### Returns @@ -1761,9 +1761,9 @@ the array of accounts #### Defined in -[src/utils/ConversionTypeHelpers.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/ConversionTypeHelpers.ts#L14) +[src/utils/ConversionTypeHelpers.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/ConversionTypeHelpers.ts#L14) ---- +___ ### noZeroX @@ -1771,8 +1771,8 @@ the array of accounts #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `input` | `string` | #### Returns @@ -1781,9 +1781,9 @@ the array of accounts #### Defined in -[src/utils/ConversionTypeHelpers.ts:5](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/ConversionTypeHelpers.ts#L5) +[src/utils/ConversionTypeHelpers.ts:5](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/ConversionTypeHelpers.ts#L5) ---- +___ ### objectPromiseAll @@ -1791,8 +1791,8 @@ the array of accounts #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `obj` | `Object` | #### Returns @@ -1801,9 +1801,9 @@ the array of accounts #### Defined in -[src/utils/PromiseResolver.ts:11](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/PromiseResolver.ts#L11) +[src/utils/PromiseResolver.ts:11](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/PromiseResolver.ts#L11) ---- +___ ### parseEther @@ -1813,8 +1813,8 @@ Converts a ether _value_ into _wei_. #### Parameters -| Name | Type | Description | -| :------ | :------- | :-------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `value` | `string` | The string value to convert | #### Returns @@ -1826,18 +1826,18 @@ The BigInt representation of _value_ in _wei_ **`Example`** ```ts -parseEther('1.0') +parseEther("1.0") // 1000000000000000000n -parseEther('-0.5') +parseEther("-0.5") // -500000000000000000n ``` #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:502](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L502) +[src/nevermined/utils/BlockchainViemUtils.ts:502](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L502) ---- +___ ### parseUnits @@ -1847,10 +1847,10 @@ Returns a BigInt representation of value, parsed with _decimal_ digits. #### Parameters -| Name | Type | Default value | Description | -| :--------- | :------- | :------------ | :-------------------------- | -| `value` | `string` | `undefined` | The string value to convert | -| `decimals` | `number` | `18` | The number of decimals | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `value` | `string` | `undefined` | The string value to convert | +| `decimals` | `number` | `18` | The number of decimals | #### Returns @@ -1861,18 +1861,18 @@ The BigInt representation of _value_ parsed with _decimals_ **`Example`** ```ts -parseUnits('1.0', 18) +parseUnits("1.0", 18) // 1000000000000000000n -parseUnits('121.0', 9) +parseUnits("121.0", 9); // 121000000000n ``` #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:465](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L465) +[src/nevermined/utils/BlockchainViemUtils.ts:465](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L465) ---- +___ ### searchAbiEvent @@ -1882,10 +1882,10 @@ It searchs an ABI event in the ABI. #### Parameters -| Name | Type | Description | -| :---------- | :------- | :---------------------- | -| `abi` | `Abi` | the ABI of the contract | -| `eventName` | `string` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `abi` | `Abi` | the ABI of the contract | +| `eventName` | `string` | - | #### Returns @@ -1895,9 +1895,9 @@ the event found #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:263](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L263) +[src/nevermined/utils/BlockchainViemUtils.ts:263](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L263) ---- +___ ### searchAbiFunction @@ -1907,11 +1907,11 @@ It searchs an ABI function in the ABI. #### Parameters -| Name | Type | Default value | Description | -| :--------- | :------- | :------------ | :----------------------- | -| `abi` | `Abi` | `undefined` | the ABI of the contract | -| `funcName` | `string` | `undefined` | the function name | -| `args` | `any`[] | `[]` | the args of the function | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `abi` | `Abi` | `undefined` | the ABI of the contract | +| `funcName` | `string` | `undefined` | the function name | +| `args` | `any`[] | `[]` | the args of the function | #### Returns @@ -1921,9 +1921,9 @@ the function found #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:245](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L245) +[src/nevermined/utils/BlockchainViemUtils.ts:245](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L245) ---- +___ ### serializeECIES @@ -1931,8 +1931,8 @@ the function found #### Parameters -| Name | Type | -| :------ | :---- | +| Name | Type | +| :------ | :------ | | `ecies` | `any` | #### Returns @@ -1941,9 +1941,9 @@ the function found #### Defined in -[src/common/helpers.ts:88](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/common/helpers.ts#L88) +[src/common/helpers.ts:88](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/common/helpers.ts#L88) ---- +___ ### urlSafeBase64Decode @@ -1951,8 +1951,8 @@ the function found #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `input` | `string` | #### Returns @@ -1961,9 +1961,9 @@ the function found #### Defined in -[src/common/helpers.ts:60](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/common/helpers.ts#L60) +[src/common/helpers.ts:60](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/common/helpers.ts#L60) ---- +___ ### urlSafeBase64Encode @@ -1971,8 +1971,8 @@ the function found #### Parameters -| Name | Type | -| :------ | :----------- | +| Name | Type | +| :------ | :------ | | `input` | `Uint8Array` | #### Returns @@ -1981,9 +1981,9 @@ the function found #### Defined in -[src/common/helpers.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/common/helpers.ts#L51) +[src/common/helpers.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/common/helpers.ts#L51) ---- +___ ### zeroPadValue @@ -1993,10 +1993,10 @@ It pads a value with zeros. #### Parameters -| Name | Type | Description | -| :------- | :------------------------------- | :----------------------------------- | -| `value` | \`0x$\{string}\` \| `Uint8Array` | the value to pad | -| `length` | `number` | the expected longitutde of the value | +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | \`0x$\{string}\` \| `Uint8Array` | the value to pad | +| `length` | `number` | the expected longitutde of the value | #### Returns @@ -2006,9 +2006,9 @@ the padded value #### Defined in -[src/nevermined/utils/BlockchainViemUtils.ts:358](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/utils/BlockchainViemUtils.ts#L358) +[src/nevermined/utils/BlockchainViemUtils.ts:358](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/utils/BlockchainViemUtils.ts#L358) ---- +___ ### zeroX @@ -2016,8 +2016,8 @@ the padded value #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `input` | `string` | #### Returns @@ -2026,9 +2026,9 @@ the padded value #### Defined in -[src/utils/ConversionTypeHelpers.ts:4](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/ConversionTypeHelpers.ts#L4) +[src/utils/ConversionTypeHelpers.ts:4](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/ConversionTypeHelpers.ts#L4) ---- +___ ### zeroXTransformer @@ -2036,10 +2036,10 @@ the padded value #### Parameters -| Name | Type | Default value | -| :----------- | :-------- | :------------ | -| `input` | `string` | `''` | -| `zeroOutput` | `boolean` | `undefined` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `input` | `string` | `''` | +| `zeroOutput` | `boolean` | `undefined` | #### Returns @@ -2047,4 +2047,4 @@ the padded value #### Defined in -[src/utils/ConversionTypeHelpers.ts:7](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/utils/ConversionTypeHelpers.ts#L7) +[src/utils/ConversionTypeHelpers.ts:7](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/utils/ConversionTypeHelpers.ts#L7) diff --git a/docs/nevermined-sdk/api-reference/enums/AccessStatus.md b/docs/nevermined-sdk/api-reference/enums/AccessStatus.md index ab5d7d1848..9a72f6a7b5 100644 --- a/docs/nevermined-sdk/api-reference/enums/AccessStatus.md +++ b/docs/nevermined-sdk/api-reference/enums/AccessStatus.md @@ -16,48 +16,48 @@ ### Committed -• **Committed** = `1` +• **Committed** = ``1`` #### Defined in -[src/types/GeneralTypes.ts:3](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L3) +[src/types/GeneralTypes.ts:3](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L3) ---- +___ ### Delivered -• **Delivered** = `2` +• **Delivered** = ``2`` #### Defined in -[src/types/GeneralTypes.ts:4](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L4) +[src/types/GeneralTypes.ts:4](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L4) ---- +___ ### Requested -• **Requested** = `0` +• **Requested** = ``0`` #### Defined in -[src/types/GeneralTypes.ts:2](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L2) +[src/types/GeneralTypes.ts:2](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L2) ---- +___ ### Revoked -• **Revoked** = `4` +• **Revoked** = ``4`` #### Defined in -[src/types/GeneralTypes.ts:6](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L6) +[src/types/GeneralTypes.ts:6](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L6) ---- +___ ### Verified -• **Verified** = `3` +• **Verified** = ``3`` #### Defined in -[src/types/GeneralTypes.ts:5](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L5) +[src/types/GeneralTypes.ts:5](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L5) diff --git a/docs/nevermined-sdk/api-reference/enums/AssetResult.md b/docs/nevermined-sdk/api-reference/enums/AssetResult.md index e60b0f1abd..925634a20b 100644 --- a/docs/nevermined-sdk/api-reference/enums/AssetResult.md +++ b/docs/nevermined-sdk/api-reference/enums/AssetResult.md @@ -14,28 +14,28 @@ ### DATA -• **DATA** = `"data"` +• **DATA** = ``"data"`` #### Defined in -[src/services/node/NeverminedNode.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L20) +[src/services/node/NeverminedNode.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L20) ---- +___ ### DECRYPTED -• **DECRYPTED** = `"decrypted"` +• **DECRYPTED** = ``"decrypted"`` #### Defined in -[src/services/node/NeverminedNode.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L21) +[src/services/node/NeverminedNode.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L21) ---- +___ ### URL -• **URL** = `"url"` +• **URL** = ``"url"`` #### Defined in -[src/services/node/NeverminedNode.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L22) +[src/services/node/NeverminedNode.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L22) diff --git a/docs/nevermined-sdk/api-reference/enums/ChargeType.md b/docs/nevermined-sdk/api-reference/enums/ChargeType.md index 27067f2f48..4ae34f5e74 100644 --- a/docs/nevermined-sdk/api-reference/enums/ChargeType.md +++ b/docs/nevermined-sdk/api-reference/enums/ChargeType.md @@ -13,18 +13,18 @@ ### Dynamic -• **Dynamic** = `"dynamic"` +• **Dynamic** = ``"dynamic"`` #### Defined in -[src/types/DDOTypes.ts:217](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L217) +[src/types/DDOTypes.ts:217](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L217) ---- +___ ### Fixed -• **Fixed** = `"fixed"` +• **Fixed** = ``"fixed"`` #### Defined in -[src/types/DDOTypes.ts:216](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L216) +[src/types/DDOTypes.ts:216](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L216) diff --git a/docs/nevermined-sdk/api-reference/enums/ConditionState.md b/docs/nevermined-sdk/api-reference/enums/ConditionState.md index 538be372e5..0abac47cbf 100644 --- a/docs/nevermined-sdk/api-reference/enums/ConditionState.md +++ b/docs/nevermined-sdk/api-reference/enums/ConditionState.md @@ -15,38 +15,38 @@ ### Aborted -• **Aborted** = `3` +• **Aborted** = ``3`` #### Defined in -[src/types/ContractTypes.ts:5](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/ContractTypes.ts#L5) +[src/types/ContractTypes.ts:5](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/ContractTypes.ts#L5) ---- +___ ### Fulfilled -• **Fulfilled** = `2` +• **Fulfilled** = ``2`` #### Defined in -[src/types/ContractTypes.ts:4](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/ContractTypes.ts#L4) +[src/types/ContractTypes.ts:4](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/ContractTypes.ts#L4) ---- +___ ### Unfulfilled -• **Unfulfilled** = `1` +• **Unfulfilled** = ``1`` #### Defined in -[src/types/ContractTypes.ts:3](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/ContractTypes.ts#L3) +[src/types/ContractTypes.ts:3](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/ContractTypes.ts#L3) ---- +___ ### Uninitialized -• **Uninitialized** = `0` +• **Uninitialized** = ``0`` #### Defined in -[src/types/ContractTypes.ts:2](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/ContractTypes.ts#L2) +[src/types/ContractTypes.ts:2](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/ContractTypes.ts#L2) diff --git a/docs/nevermined-sdk/api-reference/enums/CreateProgressStep.md b/docs/nevermined-sdk/api-reference/enums/CreateProgressStep.md index 0333bef0a3..ee1819c76c 100644 --- a/docs/nevermined-sdk/api-reference/enums/CreateProgressStep.md +++ b/docs/nevermined-sdk/api-reference/enums/CreateProgressStep.md @@ -24,128 +24,128 @@ ### ConditionsFilled -• **ConditionsFilled** = `3` +• **ConditionsFilled** = ``3`` #### Defined in -[src/nevermined/ProgressSteps.ts:5](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L5) +[src/nevermined/ProgressSteps.ts:5](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L5) ---- +___ ### DdoStored -• **DdoStored** = `10` +• **DdoStored** = ``10`` #### Defined in -[src/nevermined/ProgressSteps.ts:12](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L12) +[src/nevermined/ProgressSteps.ts:12](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L12) ---- +___ ### DdoStoredImmutable -• **DdoStoredImmutable** = `11` +• **DdoStoredImmutable** = ``11`` #### Defined in -[src/nevermined/ProgressSteps.ts:13](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L13) +[src/nevermined/ProgressSteps.ts:13](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L13) ---- +___ ### DidRegistered -• **DidRegistered** = `12` +• **DidRegistered** = ``12`` #### Defined in -[src/nevermined/ProgressSteps.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L14) +[src/nevermined/ProgressSteps.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L14) ---- +___ ### EncryptingFiles -• **EncryptingFiles** = `4` +• **EncryptingFiles** = ``4`` #### Defined in -[src/nevermined/ProgressSteps.ts:6](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L6) +[src/nevermined/ProgressSteps.ts:6](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L6) ---- +___ ### FilesEncrypted -• **FilesEncrypted** = `5` +• **FilesEncrypted** = ``5`` #### Defined in -[src/nevermined/ProgressSteps.ts:7](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L7) +[src/nevermined/ProgressSteps.ts:7](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L7) ---- +___ ### GeneratingProof -• **GeneratingProof** = `1` +• **GeneratingProof** = ``1`` #### Defined in -[src/nevermined/ProgressSteps.ts:3](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L3) +[src/nevermined/ProgressSteps.ts:3](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L3) ---- +___ ### ProofGenerated -• **ProofGenerated** = `2` +• **ProofGenerated** = ``2`` #### Defined in -[src/nevermined/ProgressSteps.ts:4](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L4) +[src/nevermined/ProgressSteps.ts:4](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L4) ---- +___ ### RegisteringDid -• **RegisteringDid** = `6` +• **RegisteringDid** = ``6`` #### Defined in -[src/nevermined/ProgressSteps.ts:8](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L8) +[src/nevermined/ProgressSteps.ts:8](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L8) ---- +___ ### ServicesAdded -• **ServicesAdded** = `0` +• **ServicesAdded** = ``0`` #### Defined in -[src/nevermined/ProgressSteps.ts:2](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L2) +[src/nevermined/ProgressSteps.ts:2](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L2) ---- +___ ### SettingRoyalties -• **SettingRoyalties** = `8` +• **SettingRoyalties** = ``8`` #### Defined in -[src/nevermined/ProgressSteps.ts:10](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L10) +[src/nevermined/ProgressSteps.ts:10](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L10) ---- +___ ### SettingRoyaltyScheme -• **SettingRoyaltyScheme** = `7` +• **SettingRoyaltyScheme** = ``7`` #### Defined in -[src/nevermined/ProgressSteps.ts:9](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L9) +[src/nevermined/ProgressSteps.ts:9](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L9) ---- +___ ### StoringDdo -• **StoringDdo** = `9` +• **StoringDdo** = ``9`` #### Defined in -[src/nevermined/ProgressSteps.ts:11](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L11) +[src/nevermined/ProgressSteps.ts:11](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L11) diff --git a/docs/nevermined-sdk/api-reference/enums/DIDResolvePolicy.md b/docs/nevermined-sdk/api-reference/enums/DIDResolvePolicy.md index 65e6c91629..b4ef98955d 100644 --- a/docs/nevermined-sdk/api-reference/enums/DIDResolvePolicy.md +++ b/docs/nevermined-sdk/api-reference/enums/DIDResolvePolicy.md @@ -3,12 +3,11 @@ # Enumeration: DIDResolvePolicy It described the policy to be used when resolving an asset. It has the following options: - -- ImmutableFirst - It checks if there is a reference to an immutable data-store (IPFS, Filecoin, etc) on-chain. If that's the case uses the URL to resolve the Metadata. If not try to resolve the metadata using the URL of the Metadata/Marketplace API -- MetadataAPIFirst - Try to resolve the metadata from the Marketplace/Metadata API, if it can't tries to resolve using the immutable url -- OnlyImmutable - Try to resolve the metadata only from the immutable data store URL -- OnlyMetadataAPI - Try to resolve the metadata only from the Metadata API. It gets the metadata api url from the DIDRegistry -- NoRegisry - Gets the metadata from the Metadata API using as endpoint the metadata api url from the SDK config. This method don't gets any on-chain information because assumes the DID is not registered on-chain +* ImmutableFirst - It checks if there is a reference to an immutable data-store (IPFS, Filecoin, etc) on-chain. If that's the case uses the URL to resolve the Metadata. If not try to resolve the metadata using the URL of the Metadata/Marketplace API +* MetadataAPIFirst - Try to resolve the metadata from the Marketplace/Metadata API, if it can't tries to resolve using the immutable url +* OnlyImmutable - Try to resolve the metadata only from the immutable data store URL +* OnlyMetadataAPI - Try to resolve the metadata only from the Metadata API. It gets the metadata api url from the DIDRegistry +* NoRegisry - Gets the metadata from the Metadata API using as endpoint the metadata api url from the SDK config. This method don't gets any on-chain information because assumes the DID is not registered on-chain ## Table of contents @@ -24,48 +23,48 @@ It described the policy to be used when resolving an asset. It has the following ### ImmutableFirst -• **ImmutableFirst** = `0` +• **ImmutableFirst** = ``0`` #### Defined in -[src/types/MetadataTypes.ts:10](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L10) +[src/types/MetadataTypes.ts:10](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L10) ---- +___ ### MetadataAPIFirst -• **MetadataAPIFirst** = `1` +• **MetadataAPIFirst** = ``1`` #### Defined in -[src/types/MetadataTypes.ts:11](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L11) +[src/types/MetadataTypes.ts:11](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L11) ---- +___ ### NoRegistry -• **NoRegistry** = `4` +• **NoRegistry** = ``4`` #### Defined in -[src/types/MetadataTypes.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L14) +[src/types/MetadataTypes.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L14) ---- +___ ### OnlyImmutable -• **OnlyImmutable** = `2` +• **OnlyImmutable** = ``2`` #### Defined in -[src/types/MetadataTypes.ts:12](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L12) +[src/types/MetadataTypes.ts:12](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L12) ---- +___ ### OnlyMetadataAPI -• **OnlyMetadataAPI** = `3` +• **OnlyMetadataAPI** = ``3`` #### Defined in -[src/types/MetadataTypes.ts:13](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L13) +[src/types/MetadataTypes.ts:13](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L13) diff --git a/docs/nevermined-sdk/api-reference/enums/ERCType.md b/docs/nevermined-sdk/api-reference/enums/ERCType.md index 07b72f644f..7834bc11d2 100644 --- a/docs/nevermined-sdk/api-reference/enums/ERCType.md +++ b/docs/nevermined-sdk/api-reference/enums/ERCType.md @@ -13,18 +13,18 @@ ### nft1155 -• **nft1155** = `1155` +• **nft1155** = ``1155`` #### Defined in -[src/types/GeneralTypes.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L16) +[src/types/GeneralTypes.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L16) ---- +___ ### nft721 -• **nft721** = `721` +• **nft721** = ``721`` #### Defined in -[src/types/GeneralTypes.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L15) +[src/types/GeneralTypes.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L15) diff --git a/docs/nevermined-sdk/api-reference/enums/ExecuteProgressStep.md b/docs/nevermined-sdk/api-reference/enums/ExecuteProgressStep.md index fc7b07541c..636ee80a9f 100644 --- a/docs/nevermined-sdk/api-reference/enums/ExecuteProgressStep.md +++ b/docs/nevermined-sdk/api-reference/enums/ExecuteProgressStep.md @@ -15,38 +15,38 @@ ### AgreementInitialized -• **AgreementInitialized** = `1` +• **AgreementInitialized** = ``1`` #### Defined in -[src/nevermined/ProgressSteps.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L39) +[src/nevermined/ProgressSteps.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L39) ---- +___ ### CreatingAgreement -• **CreatingAgreement** = `0` +• **CreatingAgreement** = ``0`` #### Defined in -[src/nevermined/ProgressSteps.ts:38](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L38) +[src/nevermined/ProgressSteps.ts:38](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L38) ---- +___ ### LockedPayment -• **LockedPayment** = `3` +• **LockedPayment** = ``3`` #### Defined in -[src/nevermined/ProgressSteps.ts:41](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L41) +[src/nevermined/ProgressSteps.ts:41](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L41) ---- +___ ### LockingPayment -• **LockingPayment** = `2` +• **LockingPayment** = ``2`` #### Defined in -[src/nevermined/ProgressSteps.ts:40](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L40) +[src/nevermined/ProgressSteps.ts:40](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L40) diff --git a/docs/nevermined-sdk/api-reference/enums/ExternalResourceFileType.md b/docs/nevermined-sdk/api-reference/enums/ExternalResourceFileType.md index 0f2ad7743c..7d31247556 100644 --- a/docs/nevermined-sdk/api-reference/enums/ExternalResourceFileType.md +++ b/docs/nevermined-sdk/api-reference/enums/ExternalResourceFileType.md @@ -17,58 +17,58 @@ ### Avatar -• **Avatar** = `"Avatar"` +• **Avatar** = ``"Avatar"`` #### Defined in -[src/types/DDOTypes.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L115) +[src/types/DDOTypes.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L115) ---- +___ ### CoverImage -• **CoverImage** = `"CoverImage"` +• **CoverImage** = ``"CoverImage"`` #### Defined in -[src/types/DDOTypes.ts:117](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L117) +[src/types/DDOTypes.ts:117](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L117) ---- +___ ### Other -• **Other** = `"Other"` +• **Other** = ``"Other"`` #### Defined in -[src/types/DDOTypes.ts:120](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L120) +[src/types/DDOTypes.ts:120](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L120) ---- +___ ### Private -• **Private** = `"Private"` +• **Private** = ``"Private"`` #### Defined in -[src/types/DDOTypes.ts:116](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L116) +[src/types/DDOTypes.ts:116](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L116) ---- +___ ### SampleData -• **SampleData** = `"SampleData"` +• **SampleData** = ``"SampleData"`` #### Defined in -[src/types/DDOTypes.ts:119](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L119) +[src/types/DDOTypes.ts:119](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L119) ---- +___ ### TermsAndConditions -• **TermsAndConditions** = `"TermsAndConditions"` +• **TermsAndConditions** = ``"TermsAndConditions"`` #### Defined in -[src/types/DDOTypes.ts:118](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L118) +[src/types/DDOTypes.ts:118](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L118) diff --git a/docs/nevermined-sdk/api-reference/enums/ImmutableBackends.md b/docs/nevermined-sdk/api-reference/enums/ImmutableBackends.md index 42b2618b2e..0318a631d5 100644 --- a/docs/nevermined-sdk/api-reference/enums/ImmutableBackends.md +++ b/docs/nevermined-sdk/api-reference/enums/ImmutableBackends.md @@ -13,18 +13,18 @@ ### Filecoin -• **Filecoin** = `"filecoin"` +• **Filecoin** = ``"filecoin"`` #### Defined in -[src/types/DDOTypes.ts:574](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L574) +[src/types/DDOTypes.ts:574](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L574) ---- +___ ### IPFS -• **IPFS** = `"ipfs"` +• **IPFS** = ``"ipfs"`` #### Defined in -[src/types/DDOTypes.ts:575](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L575) +[src/types/DDOTypes.ts:575](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L575) diff --git a/docs/nevermined-sdk/api-reference/enums/LogLevel.md b/docs/nevermined-sdk/api-reference/enums/LogLevel.md index 77211d2eed..a3b1efea90 100644 --- a/docs/nevermined-sdk/api-reference/enums/LogLevel.md +++ b/docs/nevermined-sdk/api-reference/enums/LogLevel.md @@ -16,48 +16,48 @@ ### Error -• **Error** = `0` +• **Error** = ``0`` #### Defined in -[src/models/Logger.ts:3](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/Logger.ts#L3) +[src/models/Logger.ts:3](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/Logger.ts#L3) ---- +___ ### Log -• **Log** = `2` +• **Log** = ``2`` #### Defined in -[src/models/Logger.ts:5](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/Logger.ts#L5) +[src/models/Logger.ts:5](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/Logger.ts#L5) ---- +___ ### None -• **None** = `-1` +• **None** = ``-1`` #### Defined in -[src/models/Logger.ts:2](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/Logger.ts#L2) +[src/models/Logger.ts:2](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/Logger.ts#L2) ---- +___ ### Verbose -• **Verbose** = `3` +• **Verbose** = ``3`` #### Defined in -[src/models/Logger.ts:6](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/Logger.ts#L6) +[src/models/Logger.ts:6](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/Logger.ts#L6) ---- +___ ### Warn -• **Warn** = `1` +• **Warn** = ``1`` #### Defined in -[src/models/Logger.ts:4](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/Logger.ts#L4) +[src/models/Logger.ts:4](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/Logger.ts#L4) diff --git a/docs/nevermined-sdk/api-reference/enums/NVMAppEnvironments.md b/docs/nevermined-sdk/api-reference/enums/NVMAppEnvironments.md index b85376888a..57801fff57 100644 --- a/docs/nevermined-sdk/api-reference/enums/NVMAppEnvironments.md +++ b/docs/nevermined-sdk/api-reference/enums/NVMAppEnvironments.md @@ -22,108 +22,108 @@ ### Base -• **Base** = `"base"` +• **Base** = ``"base"`` #### Defined in -[src/nevermined/NvmApp.ts:41](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L41) +[src/nevermined/NvmApp.ts:41](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L41) ---- +___ ### Celo -• **Celo** = `"celo"` +• **Celo** = ``"celo"`` #### Defined in -[src/nevermined/NvmApp.ts:42](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L42) +[src/nevermined/NvmApp.ts:42](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L42) ---- +___ ### Custom -• **Custom** = `"custom"` +• **Custom** = ``"custom"`` #### Defined in -[src/nevermined/NvmApp.ts:45](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L45) +[src/nevermined/NvmApp.ts:45](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L45) ---- +___ ### Gnosis -• **Gnosis** = `"gnosis"` +• **Gnosis** = ``"gnosis"`` #### Defined in -[src/nevermined/NvmApp.ts:40](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L40) +[src/nevermined/NvmApp.ts:40](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L40) ---- +___ ### Live -• **Live** = `"live"` +• **Live** = ``"live"`` #### Defined in -[src/nevermined/NvmApp.ts:37](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L37) +[src/nevermined/NvmApp.ts:37](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L37) ---- +___ ### Local -• **Local** = `"local"` +• **Local** = ``"local"`` #### Defined in -[src/nevermined/NvmApp.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L44) +[src/nevermined/NvmApp.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L44) ---- +___ ### Matic -• **Matic** = `"matic"` +• **Matic** = ``"matic"`` #### Defined in -[src/nevermined/NvmApp.ts:38](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L38) +[src/nevermined/NvmApp.ts:38](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L38) ---- +___ ### Mumbai -• **Mumbai** = `"mumbai"` +• **Mumbai** = ``"mumbai"`` #### Defined in -[src/nevermined/NvmApp.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L39) +[src/nevermined/NvmApp.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L39) ---- +___ ### Optimism -• **Optimism** = `"optimism"` +• **Optimism** = ``"optimism"`` #### Defined in -[src/nevermined/NvmApp.ts:43](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L43) +[src/nevermined/NvmApp.ts:43](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L43) ---- +___ ### Staging -• **Staging** = `"staging"` +• **Staging** = ``"staging"`` #### Defined in -[src/nevermined/NvmApp.ts:35](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L35) +[src/nevermined/NvmApp.ts:35](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L35) ---- +___ ### Testing -• **Testing** = `"testing"` +• **Testing** = ``"testing"`` #### Defined in -[src/nevermined/NvmApp.ts:36](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L36) +[src/nevermined/NvmApp.ts:36](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L36) diff --git a/docs/nevermined-sdk/api-reference/enums/NeverminedNFT1155Type.md b/docs/nevermined-sdk/api-reference/enums/NeverminedNFT1155Type.md index 7af403e878..eddcdf4955 100644 --- a/docs/nevermined-sdk/api-reference/enums/NeverminedNFT1155Type.md +++ b/docs/nevermined-sdk/api-reference/enums/NeverminedNFT1155Type.md @@ -13,18 +13,18 @@ ### nft1155 -• **nft1155** = `"nft1155"` +• **nft1155** = ``"nft1155"`` #### Defined in -[src/types/GeneralTypes.ts:27](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L27) +[src/types/GeneralTypes.ts:27](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L27) ---- +___ ### nft1155Credit -• **nft1155Credit** = `"nft1155-credit"` +• **nft1155Credit** = ``"nft1155-credit"`` #### Defined in -[src/types/GeneralTypes.ts:28](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L28) +[src/types/GeneralTypes.ts:28](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L28) diff --git a/docs/nevermined-sdk/api-reference/enums/NeverminedNFT721Type.md b/docs/nevermined-sdk/api-reference/enums/NeverminedNFT721Type.md index aefc24abb5..10f575c705 100644 --- a/docs/nevermined-sdk/api-reference/enums/NeverminedNFT721Type.md +++ b/docs/nevermined-sdk/api-reference/enums/NeverminedNFT721Type.md @@ -15,38 +15,38 @@ ### nft721 -• **nft721** = `"nft721"` +• **nft721** = ``"nft721"`` #### Defined in -[src/types/GeneralTypes.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L20) +[src/types/GeneralTypes.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L20) ---- +___ ### nft721POAP -• **nft721POAP** = `"nft721-poap"` +• **nft721POAP** = ``"nft721-poap"`` #### Defined in -[src/types/GeneralTypes.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L22) +[src/types/GeneralTypes.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L22) ---- +___ ### nft721SoulBound -• **nft721SoulBound** = `"nft721-soulbound"` +• **nft721SoulBound** = ``"nft721-soulbound"`` #### Defined in -[src/types/GeneralTypes.ts:23](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L23) +[src/types/GeneralTypes.ts:23](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L23) ---- +___ ### nft721Subscription -• **nft721Subscription** = `"nft721-subscription"` +• **nft721Subscription** = ``"nft721-subscription"`` #### Defined in -[src/types/GeneralTypes.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L21) +[src/types/GeneralTypes.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L21) diff --git a/docs/nevermined-sdk/api-reference/enums/NodeUploadBackends.md b/docs/nevermined-sdk/api-reference/enums/NodeUploadBackends.md index fd81bc4dcb..70adbded23 100644 --- a/docs/nevermined-sdk/api-reference/enums/NodeUploadBackends.md +++ b/docs/nevermined-sdk/api-reference/enums/NodeUploadBackends.md @@ -14,28 +14,28 @@ ### AmazonS3 -• **AmazonS3** = `"s3"` +• **AmazonS3** = ``"s3"`` #### Defined in -[src/services/node/NeverminedNode.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L16) +[src/services/node/NeverminedNode.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L16) ---- +___ ### Filecoin -• **Filecoin** = `"filecoin"` +• **Filecoin** = ``"filecoin"`` #### Defined in -[src/services/node/NeverminedNode.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L14) +[src/services/node/NeverminedNode.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L14) ---- +___ ### IPFS -• **IPFS** = `"ipfs"` +• **IPFS** = ``"ipfs"`` #### Defined in -[src/services/node/NeverminedNode.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L15) +[src/services/node/NeverminedNode.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L15) diff --git a/docs/nevermined-sdk/api-reference/enums/OrderProgressStep.md b/docs/nevermined-sdk/api-reference/enums/OrderProgressStep.md index bde6dad2d6..90ace783f5 100644 --- a/docs/nevermined-sdk/api-reference/enums/OrderProgressStep.md +++ b/docs/nevermined-sdk/api-reference/enums/OrderProgressStep.md @@ -17,58 +17,58 @@ ### AgreementInitialized -• **AgreementInitialized** = `5` +• **AgreementInitialized** = ``5`` #### Defined in -[src/nevermined/ProgressSteps.ts:34](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L34) +[src/nevermined/ProgressSteps.ts:34](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L34) ---- +___ ### ApprovedPayment -• **ApprovedPayment** = `3` +• **ApprovedPayment** = ``3`` #### Defined in -[src/nevermined/ProgressSteps.ts:32](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L32) +[src/nevermined/ProgressSteps.ts:32](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L32) ---- +___ ### ApprovingPayment -• **ApprovingPayment** = `2` +• **ApprovingPayment** = ``2`` #### Defined in -[src/nevermined/ProgressSteps.ts:31](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L31) +[src/nevermined/ProgressSteps.ts:31](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L31) ---- +___ ### CreatingAgreement -• **CreatingAgreement** = `4` +• **CreatingAgreement** = ``4`` #### Defined in -[src/nevermined/ProgressSteps.ts:33](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L33) +[src/nevermined/ProgressSteps.ts:33](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L33) ---- +___ ### LockedPayment -• **LockedPayment** = `1` +• **LockedPayment** = ``1`` #### Defined in -[src/nevermined/ProgressSteps.ts:30](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L30) +[src/nevermined/ProgressSteps.ts:30](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L30) ---- +___ ### LockingPayment -• **LockingPayment** = `0` +• **LockingPayment** = ``0`` #### Defined in -[src/nevermined/ProgressSteps.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L29) +[src/nevermined/ProgressSteps.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L29) diff --git a/docs/nevermined-sdk/api-reference/enums/PermissionType.md b/docs/nevermined-sdk/api-reference/enums/PermissionType.md index 928986c508..bc35e710b5 100644 --- a/docs/nevermined-sdk/api-reference/enums/PermissionType.md +++ b/docs/nevermined-sdk/api-reference/enums/PermissionType.md @@ -15,38 +15,38 @@ ### Admin -• **Admin** = `"admin"` +• **Admin** = ``"admin"`` #### Defined in -[src/types/MetadataTypes.ts:90](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L90) +[src/types/MetadataTypes.ts:90](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L90) ---- +___ ### Delete -• **Delete** = `"delete"` +• **Delete** = ``"delete"`` #### Defined in -[src/types/MetadataTypes.ts:89](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L89) +[src/types/MetadataTypes.ts:89](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L89) ---- +___ ### Read -• **Read** = `"read"` +• **Read** = ``"read"`` #### Defined in -[src/types/MetadataTypes.ts:87](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L87) +[src/types/MetadataTypes.ts:87](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L87) ---- +___ ### Update -• **Update** = `"update"` +• **Update** = ``"update"`` #### Defined in -[src/types/MetadataTypes.ts:88](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L88) +[src/types/MetadataTypes.ts:88](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L88) diff --git a/docs/nevermined-sdk/api-reference/enums/PlatformTechStatus.md b/docs/nevermined-sdk/api-reference/enums/PlatformTechStatus.md index dae1a9d1dd..a2e3738086 100644 --- a/docs/nevermined-sdk/api-reference/enums/PlatformTechStatus.md +++ b/docs/nevermined-sdk/api-reference/enums/PlatformTechStatus.md @@ -15,38 +15,38 @@ ### Loading -• **Loading** = `"Loading"` +• **Loading** = ``"Loading"`` #### Defined in -[src/nevermined/Versions.ts:6](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L6) +[src/nevermined/Versions.ts:6](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L6) ---- +___ ### Stopped -• **Stopped** = `"Stopped"` +• **Stopped** = ``"Stopped"`` #### Defined in -[src/nevermined/Versions.ts:8](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L8) +[src/nevermined/Versions.ts:8](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L8) ---- +___ ### Unknown -• **Unknown** = `"Unknown"` +• **Unknown** = ``"Unknown"`` #### Defined in -[src/nevermined/Versions.ts:7](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L7) +[src/nevermined/Versions.ts:7](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L7) ---- +___ ### Working -• **Working** = `"Working"` +• **Working** = ``"Working"`` #### Defined in -[src/nevermined/Versions.ts:9](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L9) +[src/nevermined/Versions.ts:9](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L9) diff --git a/docs/nevermined-sdk/api-reference/enums/ProvenanceMethod.md b/docs/nevermined-sdk/api-reference/enums/ProvenanceMethod.md index 0ebae667d8..e9832ddf18 100644 --- a/docs/nevermined-sdk/api-reference/enums/ProvenanceMethod.md +++ b/docs/nevermined-sdk/api-reference/enums/ProvenanceMethod.md @@ -6,146 +6,146 @@ ### Enumeration Members -- [ACTED_ON_BEHALF](ProvenanceMethod.md#acted_on_behalf) +- [ACTED\_ON\_BEHALF](ProvenanceMethod.md#acted_on_behalf) - [ACTIVITY](ProvenanceMethod.md#activity) - [AGENT](ProvenanceMethod.md#agent) - [ENTITY](ProvenanceMethod.md#entity) - [USED](ProvenanceMethod.md#used) -- [WAS_ASSOCIATED_WITH](ProvenanceMethod.md#was_associated_with) -- [WAS_ATTRIBUTED_TO](ProvenanceMethod.md#was_attributed_to) -- [WAS_DERIVED_FROM](ProvenanceMethod.md#was_derived_from) -- [WAS_ENDED_BY](ProvenanceMethod.md#was_ended_by) -- [WAS_GENERATED_BY](ProvenanceMethod.md#was_generated_by) -- [WAS_INFORMED_BY](ProvenanceMethod.md#was_informed_by) -- [WAS_INVALIDATED_BY](ProvenanceMethod.md#was_invalidated_by) -- [WAS_STARTED_BY](ProvenanceMethod.md#was_started_by) +- [WAS\_ASSOCIATED\_WITH](ProvenanceMethod.md#was_associated_with) +- [WAS\_ATTRIBUTED\_TO](ProvenanceMethod.md#was_attributed_to) +- [WAS\_DERIVED\_FROM](ProvenanceMethod.md#was_derived_from) +- [WAS\_ENDED\_BY](ProvenanceMethod.md#was_ended_by) +- [WAS\_GENERATED\_BY](ProvenanceMethod.md#was_generated_by) +- [WAS\_INFORMED\_BY](ProvenanceMethod.md#was_informed_by) +- [WAS\_INVALIDATED\_BY](ProvenanceMethod.md#was_invalidated_by) +- [WAS\_STARTED\_BY](ProvenanceMethod.md#was_started_by) ## Enumeration Members -### ACTED_ON_BEHALF +### ACTED\_ON\_BEHALF -• **ACTED_ON_BEHALF** = `12` +• **ACTED\_ON\_BEHALF** = ``12`` #### Defined in -[src/keeper/contracts/Provenance.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L22) +[src/keeper/contracts/Provenance.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L22) ---- +___ ### ACTIVITY -• **ACTIVITY** = `1` +• **ACTIVITY** = ``1`` #### Defined in -[src/keeper/contracts/Provenance.ts:11](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L11) +[src/keeper/contracts/Provenance.ts:11](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L11) ---- +___ ### AGENT -• **AGENT** = `9` +• **AGENT** = ``9`` #### Defined in -[src/keeper/contracts/Provenance.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L19) +[src/keeper/contracts/Provenance.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L19) ---- +___ ### ENTITY -• **ENTITY** = `0` +• **ENTITY** = ``0`` #### Defined in -[src/keeper/contracts/Provenance.ts:10](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L10) +[src/keeper/contracts/Provenance.ts:10](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L10) ---- +___ ### USED -• **USED** = `3` +• **USED** = ``3`` #### Defined in -[src/keeper/contracts/Provenance.ts:13](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L13) +[src/keeper/contracts/Provenance.ts:13](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L13) ---- +___ -### WAS_ASSOCIATED_WITH +### WAS\_ASSOCIATED\_WITH -• **WAS_ASSOCIATED_WITH** = `11` +• **WAS\_ASSOCIATED\_WITH** = ``11`` #### Defined in -[src/keeper/contracts/Provenance.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L21) +[src/keeper/contracts/Provenance.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L21) ---- +___ -### WAS_ATTRIBUTED_TO +### WAS\_ATTRIBUTED\_TO -• **WAS_ATTRIBUTED_TO** = `10` +• **WAS\_ATTRIBUTED\_TO** = ``10`` #### Defined in -[src/keeper/contracts/Provenance.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L20) +[src/keeper/contracts/Provenance.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L20) ---- +___ -### WAS_DERIVED_FROM +### WAS\_DERIVED\_FROM -• **WAS_DERIVED_FROM** = `8` +• **WAS\_DERIVED\_FROM** = ``8`` #### Defined in -[src/keeper/contracts/Provenance.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L18) +[src/keeper/contracts/Provenance.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L18) ---- +___ -### WAS_ENDED_BY +### WAS\_ENDED\_BY -• **WAS_ENDED_BY** = `6` +• **WAS\_ENDED\_BY** = ``6`` #### Defined in -[src/keeper/contracts/Provenance.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L16) +[src/keeper/contracts/Provenance.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L16) ---- +___ -### WAS_GENERATED_BY +### WAS\_GENERATED\_BY -• **WAS_GENERATED_BY** = `2` +• **WAS\_GENERATED\_BY** = ``2`` #### Defined in -[src/keeper/contracts/Provenance.ts:12](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L12) +[src/keeper/contracts/Provenance.ts:12](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L12) ---- +___ -### WAS_INFORMED_BY +### WAS\_INFORMED\_BY -• **WAS_INFORMED_BY** = `4` +• **WAS\_INFORMED\_BY** = ``4`` #### Defined in -[src/keeper/contracts/Provenance.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L14) +[src/keeper/contracts/Provenance.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L14) ---- +___ -### WAS_INVALIDATED_BY +### WAS\_INVALIDATED\_BY -• **WAS_INVALIDATED_BY** = `7` +• **WAS\_INVALIDATED\_BY** = ``7`` #### Defined in -[src/keeper/contracts/Provenance.ts:17](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L17) +[src/keeper/contracts/Provenance.ts:17](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L17) ---- +___ -### WAS_STARTED_BY +### WAS\_STARTED\_BY -• **WAS_STARTED_BY** = `5` +• **WAS\_STARTED\_BY** = ``5`` #### Defined in -[src/keeper/contracts/Provenance.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L15) +[src/keeper/contracts/Provenance.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L15) diff --git a/docs/nevermined-sdk/api-reference/enums/PublishMetadataOptions.md b/docs/nevermined-sdk/api-reference/enums/PublishMetadataOptions.md index 5a9dd93ea8..7653f328b2 100644 --- a/docs/nevermined-sdk/api-reference/enums/PublishMetadataOptions.md +++ b/docs/nevermined-sdk/api-reference/enums/PublishMetadataOptions.md @@ -3,7 +3,6 @@ # Enumeration: PublishMetadataOptions Where the metadata will be published. Options: - - OnlyMetadataAPI, The metadata will be stored only in the Metadata/Marketplace API - IPFS, The metadata will be stored in the Metadata/Marketplace API and IPFS - Filecoin, The metadata will be stored in the Metadata/Marketplace API and Filecoin @@ -22,38 +21,38 @@ Where the metadata will be published. Options: ### Arweave -• **Arweave** = `3` +• **Arweave** = ``3`` #### Defined in -[src/types/MetadataTypes.ts:28](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L28) +[src/types/MetadataTypes.ts:28](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L28) ---- +___ ### Filecoin -• **Filecoin** = `2` +• **Filecoin** = ``2`` #### Defined in -[src/types/MetadataTypes.ts:27](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L27) +[src/types/MetadataTypes.ts:27](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L27) ---- +___ ### IPFS -• **IPFS** = `1` +• **IPFS** = ``1`` #### Defined in -[src/types/MetadataTypes.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L26) +[src/types/MetadataTypes.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L26) ---- +___ ### OnlyMetadataAPI -• **OnlyMetadataAPI** = `0` +• **OnlyMetadataAPI** = ``0`` #### Defined in -[src/types/MetadataTypes.ts:25](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L25) +[src/types/MetadataTypes.ts:25](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L25) diff --git a/docs/nevermined-sdk/api-reference/enums/PublishOnChainOptions.md b/docs/nevermined-sdk/api-reference/enums/PublishOnChainOptions.md index 25c1e24612..6171f503dd 100644 --- a/docs/nevermined-sdk/api-reference/enums/PublishOnChainOptions.md +++ b/docs/nevermined-sdk/api-reference/enums/PublishOnChainOptions.md @@ -15,18 +15,18 @@ It specifies if the DID will be published on-chain initially or not. ### DIDRegistry -• **DIDRegistry** = `0` +• **DIDRegistry** = ``0`` #### Defined in -[src/types/MetadataTypes.ts:35](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L35) +[src/types/MetadataTypes.ts:35](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L35) ---- +___ ### OnlyOffchain -• **OnlyOffchain** = `1` +• **OnlyOffchain** = ``1`` #### Defined in -[src/types/MetadataTypes.ts:36](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L36) +[src/types/MetadataTypes.ts:36](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L36) diff --git a/docs/nevermined-sdk/api-reference/enums/RoyaltyKind.md b/docs/nevermined-sdk/api-reference/enums/RoyaltyKind.md index 6b6e0767d3..e5a56626aa 100644 --- a/docs/nevermined-sdk/api-reference/enums/RoyaltyKind.md +++ b/docs/nevermined-sdk/api-reference/enums/RoyaltyKind.md @@ -16,28 +16,28 @@ The type of royalty ### Curve -• **Curve** = `1` +• **Curve** = ``1`` #### Defined in -[src/types/MetadataTypes.ts:49](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L49) +[src/types/MetadataTypes.ts:49](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L49) ---- +___ ### Legacy -• **Legacy** = `2` +• **Legacy** = ``2`` #### Defined in -[src/types/MetadataTypes.ts:50](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L50) +[src/types/MetadataTypes.ts:50](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L50) ---- +___ ### Standard -• **Standard** = `0` +• **Standard** = ``0`` #### Defined in -[src/types/MetadataTypes.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L48) +[src/types/MetadataTypes.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L48) diff --git a/docs/nevermined-sdk/api-reference/enums/State.md b/docs/nevermined-sdk/api-reference/enums/State.md index d1fafde156..5d5fa85ede 100644 --- a/docs/nevermined-sdk/api-reference/enums/State.md +++ b/docs/nevermined-sdk/api-reference/enums/State.md @@ -14,28 +14,28 @@ ### Confirmed -• **Confirmed** = `"confirmed"` +• **Confirmed** = ``"confirmed"`` #### Defined in -[src/types/MetadataTypes.ts:108](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L108) +[src/types/MetadataTypes.ts:108](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L108) ---- +___ ### Disabled -• **Disabled** = `"disabled"` +• **Disabled** = ``"disabled"`` #### Defined in -[src/types/MetadataTypes.ts:106](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L106) +[src/types/MetadataTypes.ts:106](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L106) ---- +___ ### Unconfirmed -• **Unconfirmed** = `"unconfirmed"` +• **Unconfirmed** = ``"unconfirmed"`` #### Defined in -[src/types/MetadataTypes.ts:107](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L107) +[src/types/MetadataTypes.ts:107](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L107) diff --git a/docs/nevermined-sdk/api-reference/enums/SubscriptionType.md b/docs/nevermined-sdk/api-reference/enums/SubscriptionType.md index 80c1efa7bb..8cc2ab8040 100644 --- a/docs/nevermined-sdk/api-reference/enums/SubscriptionType.md +++ b/docs/nevermined-sdk/api-reference/enums/SubscriptionType.md @@ -14,28 +14,28 @@ ### Both -• **Both** = `"both"` +• **Both** = ``"both"`` #### Defined in -[src/types/DDOTypes.ts:212](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L212) +[src/types/DDOTypes.ts:212](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L212) ---- +___ ### Credits -• **Credits** = `"credits"` +• **Credits** = ``"credits"`` #### Defined in -[src/types/DDOTypes.ts:211](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L211) +[src/types/DDOTypes.ts:211](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L211) ---- +___ ### Time -• **Time** = `"time"` +• **Time** = ``"time"`` #### Defined in -[src/types/DDOTypes.ts:210](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L210) +[src/types/DDOTypes.ts:210](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L210) diff --git a/docs/nevermined-sdk/api-reference/enums/TemplateState.md b/docs/nevermined-sdk/api-reference/enums/TemplateState.md index 63b309e772..9eea660fa8 100644 --- a/docs/nevermined-sdk/api-reference/enums/TemplateState.md +++ b/docs/nevermined-sdk/api-reference/enums/TemplateState.md @@ -15,38 +15,38 @@ ### Approved -• **Approved** = `2` +• **Approved** = ``2`` #### Defined in -[src/keeper/contracts/managers/TemplateStoreManager.ts:10](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/TemplateStoreManager.ts#L10) +[src/keeper/contracts/managers/TemplateStoreManager.ts:10](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/TemplateStoreManager.ts#L10) ---- +___ ### Proposed -• **Proposed** = `1` +• **Proposed** = ``1`` #### Defined in -[src/keeper/contracts/managers/TemplateStoreManager.ts:9](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/TemplateStoreManager.ts#L9) +[src/keeper/contracts/managers/TemplateStoreManager.ts:9](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/TemplateStoreManager.ts#L9) ---- +___ ### Revoked -• **Revoked** = `3` +• **Revoked** = ``3`` #### Defined in -[src/keeper/contracts/managers/TemplateStoreManager.ts:11](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/TemplateStoreManager.ts#L11) +[src/keeper/contracts/managers/TemplateStoreManager.ts:11](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/TemplateStoreManager.ts#L11) ---- +___ ### Uninitialized -• **Uninitialized** = `0` +• **Uninitialized** = ``0`` #### Defined in -[src/keeper/contracts/managers/TemplateStoreManager.ts:8](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/TemplateStoreManager.ts#L8) +[src/keeper/contracts/managers/TemplateStoreManager.ts:8](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/TemplateStoreManager.ts#L8) diff --git a/docs/nevermined-sdk/api-reference/enums/UpdateProgressStep.md b/docs/nevermined-sdk/api-reference/enums/UpdateProgressStep.md index 55b253fb4d..59ab8eb761 100644 --- a/docs/nevermined-sdk/api-reference/enums/UpdateProgressStep.md +++ b/docs/nevermined-sdk/api-reference/enums/UpdateProgressStep.md @@ -19,78 +19,78 @@ ### AddVersionInDDO -• **AddVersionInDDO** = `2` +• **AddVersionInDDO** = ``2`` #### Defined in -[src/nevermined/ProgressSteps.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L20) +[src/nevermined/ProgressSteps.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L20) ---- +___ ### AssetUpdated -• **AssetUpdated** = `7` +• **AssetUpdated** = ``7`` #### Defined in -[src/nevermined/ProgressSteps.ts:25](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L25) +[src/nevermined/ProgressSteps.ts:25](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L25) ---- +___ ### CalculateChecksum -• **CalculateChecksum** = `3` +• **CalculateChecksum** = ``3`` #### Defined in -[src/nevermined/ProgressSteps.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L21) +[src/nevermined/ProgressSteps.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L21) ---- +___ ### ResolveAsset -• **ResolveAsset** = `0` +• **ResolveAsset** = ``0`` #### Defined in -[src/nevermined/ProgressSteps.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L18) +[src/nevermined/ProgressSteps.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L18) ---- +___ ### StoringDDOMarketplaceAPI -• **StoringDDOMarketplaceAPI** = `6` +• **StoringDDOMarketplaceAPI** = ``6`` #### Defined in -[src/nevermined/ProgressSteps.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L24) +[src/nevermined/ProgressSteps.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L24) ---- +___ ### StoringImmutableDDO -• **StoringImmutableDDO** = `4` +• **StoringImmutableDDO** = ``4`` #### Defined in -[src/nevermined/ProgressSteps.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L22) +[src/nevermined/ProgressSteps.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L22) ---- +___ ### UpdateMetadataInDDO -• **UpdateMetadataInDDO** = `1` +• **UpdateMetadataInDDO** = ``1`` #### Defined in -[src/nevermined/ProgressSteps.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L19) +[src/nevermined/ProgressSteps.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L19) ---- +___ ### UpdatingAssetOnChain -• **UpdatingAssetOnChain** = `5` +• **UpdatingAssetOnChain** = ``5`` #### Defined in -[src/nevermined/ProgressSteps.ts:23](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/ProgressSteps.ts#L23) +[src/nevermined/ProgressSteps.ts:23](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/ProgressSteps.ts#L23) diff --git a/docs/nevermined-sdk/api-reference/enums/ValueType.md b/docs/nevermined-sdk/api-reference/enums/ValueType.md index 01f9948c06..8728bec8c1 100644 --- a/docs/nevermined-sdk/api-reference/enums/ValueType.md +++ b/docs/nevermined-sdk/api-reference/enums/ValueType.md @@ -15,38 +15,38 @@ ### DDO -• **DDO** = `3` +• **DDO** = ``3`` #### Defined in -[src/types/GeneralTypes.ts:49](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L49) +[src/types/GeneralTypes.ts:49](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L49) ---- +___ ### DID -• **DID** = `0` +• **DID** = ``0`` #### Defined in -[src/types/GeneralTypes.ts:46](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L46) +[src/types/GeneralTypes.ts:46](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L46) ---- +___ ### DIDRef -• **DIDRef** = `1` +• **DIDRef** = ``1`` #### Defined in -[src/types/GeneralTypes.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L47) +[src/types/GeneralTypes.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L47) ---- +___ ### URL -• **URL** = `2` +• **URL** = ``2`` #### Defined in -[src/types/GeneralTypes.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L48) +[src/types/GeneralTypes.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L48) diff --git a/docs/nevermined-sdk/api-reference/enums/utils.LogLevel.md b/docs/nevermined-sdk/api-reference/enums/utils.LogLevel.md deleted file mode 100644 index 8fa35b1434..0000000000 --- a/docs/nevermined-sdk/api-reference/enums/utils.LogLevel.md +++ /dev/null @@ -1,65 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [utils](../modules/utils.md) / LogLevel - -# Enumeration: LogLevel - -[utils](../modules/utils.md).LogLevel - -## Table of contents - -### Enumeration Members - -- [Error](utils.LogLevel.md#error) -- [Log](utils.LogLevel.md#log) -- [None](utils.LogLevel.md#none) -- [Verbose](utils.LogLevel.md#verbose) -- [Warn](utils.LogLevel.md#warn) - -## Enumeration Members - -### Error - -• **Error** = ``0`` - -#### Defined in - -[src/utils/Logger.ts:3](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L3) - -___ - -### Log - -• **Log** = ``2`` - -#### Defined in - -[src/utils/Logger.ts:5](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L5) - -___ - -### None - -• **None** = ``-1`` - -#### Defined in - -[src/utils/Logger.ts:2](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L2) - -___ - -### Verbose - -• **Verbose** = ``3`` - -#### Defined in - -[src/utils/Logger.ts:6](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L6) - -___ - -### Warn - -• **Warn** = ``1`` - -#### Defined in - -[src/utils/Logger.ts:4](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L4) diff --git a/docs/nevermined-sdk/api-reference/enums/utils.OrderProgressStep.md b/docs/nevermined-sdk/api-reference/enums/utils.OrderProgressStep.md deleted file mode 100644 index d241767762..0000000000 --- a/docs/nevermined-sdk/api-reference/enums/utils.OrderProgressStep.md +++ /dev/null @@ -1,54 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [utils](../modules/utils.md) / OrderProgressStep - -# Enumeration: OrderProgressStep - -[utils](../modules/utils.md).OrderProgressStep - -## Table of contents - -### Enumeration Members - -- [AgreementInitialized](utils.OrderProgressStep.md#agreementinitialized) -- [ApprovedPayment](utils.OrderProgressStep.md#approvedpayment) -- [ApprovingPayment](utils.OrderProgressStep.md#approvingpayment) -- [CreatingAgreement](utils.OrderProgressStep.md#creatingagreement) - -## Enumeration Members - -### AgreementInitialized - -• **AgreementInitialized** = ``3`` - -#### Defined in - -[src/utils/index.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/index.ts#L20) - -___ - -### ApprovedPayment - -• **ApprovedPayment** = ``1`` - -#### Defined in - -[src/utils/index.ts:18](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/index.ts#L18) - -___ - -### ApprovingPayment - -• **ApprovingPayment** = ``0`` - -#### Defined in - -[src/utils/index.ts:17](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/index.ts#L17) - -___ - -### CreatingAgreement - -• **CreatingAgreement** = ``2`` - -#### Defined in - -[src/utils/index.ts:19](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/index.ts#L19) diff --git a/docs/nevermined-sdk/api-reference/interfaces/AccessProofTemplateParams.md b/docs/nevermined-sdk/api-reference/interfaces/AccessProofTemplateParams.md index fc01ba3d43..5e7d6208f1 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/AccessProofTemplateParams.md +++ b/docs/nevermined-sdk/api-reference/interfaces/AccessProofTemplateParams.md @@ -18,9 +18,9 @@ #### Defined in -[src/nevermined/AccessService.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L24) +[src/nevermined/AccessService.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L24) ---- +___ ### consumerId @@ -28,14 +28,14 @@ #### Defined in -[src/nevermined/AccessService.ts:25](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L25) +[src/nevermined/AccessService.ts:25](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L25) ---- +___ ### type -• **type**: `"access-proof"` +• **type**: ``"access-proof"`` #### Defined in -[src/nevermined/AccessService.ts:23](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/AccessService.ts#L23) +[src/nevermined/AccessService.ts:23](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/AccessService.ts#L23) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ActedOnBehalfEvent.md b/docs/nevermined-sdk/api-reference/interfaces/ActedOnBehalfEvent.md index 6e729e33cf..d1ee610835 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ActedOnBehalfEvent.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ActedOnBehalfEvent.md @@ -34,9 +34,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:53](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L53) +[src/keeper/contracts/Provenance.ts:53](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L53) ---- +___ ### attributes @@ -48,9 +48,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:55](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L55) +[src/keeper/contracts/Provenance.ts:55](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L55) ---- +___ ### blockNumberUpdated @@ -62,9 +62,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:56](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L56) +[src/keeper/contracts/Provenance.ts:56](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L56) ---- +___ ### delegateAgentId @@ -72,9 +72,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:77](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L77) +[src/keeper/contracts/Provenance.ts:77](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L77) ---- +___ ### entityDid @@ -82,9 +82,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L76) +[src/keeper/contracts/Provenance.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L76) ---- +___ ### event @@ -96,9 +96,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L51) +[src/keeper/contracts/Provenance.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L51) ---- +___ ### method @@ -110,9 +110,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L52) +[src/keeper/contracts/Provenance.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L52) ---- +___ ### provId @@ -124,9 +124,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:54](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L54) +[src/keeper/contracts/Provenance.ts:54](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L54) ---- +___ ### responsibleAgentId @@ -134,4 +134,4 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:78](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L78) +[src/keeper/contracts/Provenance.ts:78](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L78) diff --git a/docs/nevermined-sdk/api-reference/interfaces/AdditionalInformation.md b/docs/nevermined-sdk/api-reference/interfaces/AdditionalInformation.md index 6f8cdda9e9..917b18a7ff 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/AdditionalInformation.md +++ b/docs/nevermined-sdk/api-reference/interfaces/AdditionalInformation.md @@ -39,14 +39,14 @@ Categories used to describe this content. Empty by default. **`Example`** ```ts -;['Economy', 'Data Science'] +["Economy", "Data Science"] ``` #### Defined in -[src/types/DDOTypes.ts:425](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L425) +[src/types/DDOTypes.ts:425](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L425) ---- +___ ### cipher @@ -54,9 +54,9 @@ Categories used to describe this content. Empty by default. #### Defined in -[src/types/DDOTypes.ts:459](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L459) +[src/types/DDOTypes.ts:459](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L459) ---- +___ ### copyrightHolder @@ -67,14 +67,14 @@ The party holding the legal copyright. Empty by default. **`Example`** ```ts -'Met Office' +"Met Office" ``` #### Defined in -[src/types/DDOTypes.ts:385](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L385) +[src/types/DDOTypes.ts:385](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L385) ---- +___ ### customData @@ -89,9 +89,9 @@ Can be used to store any non-default data, needs to be checked #### Defined in -[src/types/DDOTypes.ts:454](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L454) +[src/types/DDOTypes.ts:454](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L454) ---- +___ ### description @@ -103,14 +103,14 @@ explains what the data represents and what it can be used for. **`Example`** ```ts -'Weather information of UK including temperature and humidity' +"Weather information of UK including temperature and humidity" ``` #### Defined in -[src/types/DDOTypes.ts:379](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L379) +[src/types/DDOTypes.ts:379](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L379) ---- +___ ### inLanguage @@ -122,18 +122,18 @@ codes from the [IETF BCP 47 standard](https://tools.ietf.org/html/bcp47). **`Example`** ```ts -'en' +"en" ``` #### Defined in -[src/types/DDOTypes.ts:419](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L419) +[src/types/DDOTypes.ts:419](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L419) ---- +___ ### links -• `Optional` **links**: \{ `[name: string]`: `string`; }[] +• `Optional` **links**: \{ `[name: string]`: `string`; }[] Mapping of links for data samples, or links to find out more information. Links may be to either a URL or another Asset. We expect marketplaces to @@ -144,22 +144,21 @@ to be domain-specific. **`Example`** ```ts -;[ - { - anotherSample: - 'http://data.ceda.ac.uk/badc/ukcp09/data/gridded-land-obs/gridded-land-obs-daily/', - }, - { - fieldsDescription: 'http://data.ceda.ac.uk/badc/ukcp09/', - }, -] +[ + { + anotherSample: "http://data.ceda.ac.uk/badc/ukcp09/data/gridded-land-obs/gridded-land-obs-daily/", + }, + { + fieldsDescription: "http://data.ceda.ac.uk/badc/ukcp09/", + }, + ] ``` #### Defined in -[src/types/DDOTypes.ts:412](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L412) +[src/types/DDOTypes.ts:412](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L412) ---- +___ ### poseidonHash @@ -167,9 +166,9 @@ to be domain-specific. #### Defined in -[src/types/DDOTypes.ts:458](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L458) +[src/types/DDOTypes.ts:458](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L458) ---- +___ ### priceHighestDenomination @@ -185,9 +184,9 @@ BigNumbers #### Defined in -[src/types/DDOTypes.ts:479](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L479) +[src/types/DDOTypes.ts:479](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L479) ---- +___ ### providerKey @@ -195,16 +194,16 @@ BigNumbers #### Type declaration -| Name | Type | -| :--- | :------- | -| `x` | `string` | -| `y` | `string` | +| Name | Type | +| :------ | :------ | +| `x` | `string` | +| `y` | `string` | #### Defined in -[src/types/DDOTypes.ts:461](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L461) +[src/types/DDOTypes.ts:461](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L461) ---- +___ ### secretId @@ -212,29 +211,29 @@ BigNumbers #### Type declaration -| Name | Type | -| :--- | :------- | -| `x` | `string` | -| `y` | `string` | +| Name | Type | +| :------ | :------ | +| `x` | `string` | +| `y` | `string` | #### Defined in -[src/types/DDOTypes.ts:466](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L466) +[src/types/DDOTypes.ts:466](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L466) ---- +___ ### structuredMarkup -• `Optional` **structuredMarkup**: \{ `mediaType`: `string` ; `uri`: `string` }[] +• `Optional` **structuredMarkup**: \{ `mediaType`: `string` ; `uri`: `string` }[] A link to machine-readable structured markup (such as ttl/json-ld/rdf) describing the dataset. #### Defined in -[src/types/DDOTypes.ts:445](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L445) +[src/types/DDOTypes.ts:445](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L445) ---- +___ ### tags @@ -245,14 +244,14 @@ Keywords or tags used to describe this content. Empty by default. **`Example`** ```ts -;['weather', 'uk', '2011', 'temperature', 'humidity'] +["weather", "uk", "2011", "temperature", "humidity"] ``` #### Defined in -[src/types/DDOTypes.ts:431](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L431) +[src/types/DDOTypes.ts:431](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L431) ---- +___ ### updateFrequency @@ -265,14 +264,14 @@ to get updated. **`Example`** ```ts -'yearly' +"yearly" ``` #### Defined in -[src/types/DDOTypes.ts:439](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L439) +[src/types/DDOTypes.ts:439](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L439) ---- +___ ### workExample @@ -284,9 +283,9 @@ of the metadata, not an external link. **`Example`** ```ts -'423432fsd,51.509865,-0.118092,2011-01-01T10:55:11+00:00,7.2,68' +"423432fsd,51.509865,-0.118092,2011-01-01T10:55:11+00:00,7.2,68" ``` #### Defined in -[src/types/DDOTypes.ts:392](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L392) +[src/types/DDOTypes.ts:392](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L392) diff --git a/docs/nevermined-sdk/api-reference/interfaces/AgreementConditionsStatus.md b/docs/nevermined-sdk/api-reference/interfaces/AgreementConditionsStatus.md index 592a18c8a4..3f26f65fa1 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/AgreementConditionsStatus.md +++ b/docs/nevermined-sdk/api-reference/interfaces/AgreementConditionsStatus.md @@ -4,4 +4,4 @@ ## Indexable -▪ [condition: `string`]: \{ `blocked`: `boolean` ; `blockedBy`: `string`[] ; `condition`: `string` ; `contractName`: `string` ; `state`: [`ConditionState`](../enums/ConditionState.md) } +▪ [condition: `string`]: \{ `blocked`: `boolean` ; `blockedBy`: `string`[] ; `condition`: `string` ; `contractName`: `string` ; `state`: [`ConditionState`](../enums/ConditionState.md) } diff --git a/docs/nevermined-sdk/api-reference/interfaces/AgreementData.md b/docs/nevermined-sdk/api-reference/interfaces/AgreementData.md index 32264fb471..4aed8fd4fc 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/AgreementData.md +++ b/docs/nevermined-sdk/api-reference/interfaces/AgreementData.md @@ -23,9 +23,9 @@ #### Defined in -[src/keeper/contracts/managers/AgreementStoreManager.ts:11](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/AgreementStoreManager.ts#L11) +[src/keeper/contracts/managers/AgreementStoreManager.ts:11](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/AgreementStoreManager.ts#L11) ---- +___ ### agreementIdSeed @@ -33,9 +33,9 @@ #### Defined in -[src/keeper/contracts/managers/AgreementStoreManager.ts:12](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/AgreementStoreManager.ts#L12) +[src/keeper/contracts/managers/AgreementStoreManager.ts:12](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/AgreementStoreManager.ts#L12) ---- +___ ### conditionIdSeeds @@ -43,9 +43,9 @@ #### Defined in -[src/keeper/contracts/managers/AgreementStoreManager.ts:17](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/AgreementStoreManager.ts#L17) +[src/keeper/contracts/managers/AgreementStoreManager.ts:17](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/AgreementStoreManager.ts#L17) ---- +___ ### conditionIds @@ -53,9 +53,9 @@ #### Defined in -[src/keeper/contracts/managers/AgreementStoreManager.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/AgreementStoreManager.ts#L16) +[src/keeper/contracts/managers/AgreementStoreManager.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/AgreementStoreManager.ts#L16) ---- +___ ### creator @@ -63,9 +63,9 @@ #### Defined in -[src/keeper/contracts/managers/AgreementStoreManager.ts:13](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/AgreementStoreManager.ts#L13) +[src/keeper/contracts/managers/AgreementStoreManager.ts:13](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/AgreementStoreManager.ts#L13) ---- +___ ### did @@ -73,9 +73,9 @@ #### Defined in -[src/keeper/contracts/managers/AgreementStoreManager.ts:10](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/AgreementStoreManager.ts#L10) +[src/keeper/contracts/managers/AgreementStoreManager.ts:10](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/AgreementStoreManager.ts#L10) ---- +___ ### didOwner @@ -83,9 +83,9 @@ #### Defined in -[src/keeper/contracts/managers/AgreementStoreManager.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/AgreementStoreManager.ts#L14) +[src/keeper/contracts/managers/AgreementStoreManager.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/AgreementStoreManager.ts#L14) ---- +___ ### templateId @@ -93,4 +93,4 @@ #### Defined in -[src/keeper/contracts/managers/AgreementStoreManager.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/AgreementStoreManager.ts#L15) +[src/keeper/contracts/managers/AgreementStoreManager.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/AgreementStoreManager.ts#L15) diff --git a/docs/nevermined-sdk/api-reference/interfaces/AgreementPrepareResult.md b/docs/nevermined-sdk/api-reference/interfaces/AgreementPrepareResult.md index 1d9f787c68..de4e04d166 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/AgreementPrepareResult.md +++ b/docs/nevermined-sdk/api-reference/interfaces/AgreementPrepareResult.md @@ -17,9 +17,9 @@ #### Defined in -[src/nevermined/api/AgreementsApi.ts:10](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AgreementsApi.ts#L10) +[src/nevermined/api/AgreementsApi.ts:10](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AgreementsApi.ts#L10) ---- +___ ### signature @@ -27,4 +27,4 @@ #### Defined in -[src/nevermined/api/AgreementsApi.ts:11](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AgreementsApi.ts#L11) +[src/nevermined/api/AgreementsApi.ts:11](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AgreementsApi.ts#L11) diff --git a/docs/nevermined-sdk/api-reference/interfaces/Algorithm.md b/docs/nevermined-sdk/api-reference/interfaces/Algorithm.md index 0f7a3310df..b1df9cd602 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/Algorithm.md +++ b/docs/nevermined-sdk/api-reference/interfaces/Algorithm.md @@ -20,9 +20,9 @@ #### Defined in -[src/types/DDOTypes.ts:85](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L85) +[src/types/DDOTypes.ts:85](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L85) ---- +___ ### format @@ -30,9 +30,9 @@ #### Defined in -[src/types/DDOTypes.ts:83](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L83) +[src/types/DDOTypes.ts:83](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L83) ---- +___ ### language @@ -40,9 +40,9 @@ #### Defined in -[src/types/DDOTypes.ts:82](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L82) +[src/types/DDOTypes.ts:82](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L82) ---- +___ ### requirements @@ -50,17 +50,17 @@ #### Type declaration -| Name | Type | -| :------------- | :------- | -| `container?` | `any` | +| Name | Type | +| :------ | :------ | +| `container?` | `any` | | `requirement?` | `string` | -| `version?` | `string` | +| `version?` | `string` | #### Defined in -[src/types/DDOTypes.ts:86](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L86) +[src/types/DDOTypes.ts:86](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L86) ---- +___ ### version @@ -68,4 +68,4 @@ #### Defined in -[src/types/DDOTypes.ts:84](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L84) +[src/types/DDOTypes.ts:84](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L84) diff --git a/docs/nevermined-sdk/api-reference/interfaces/AuthToken.md b/docs/nevermined-sdk/api-reference/interfaces/AuthToken.md index 049d7bfc2c..51c892a32f 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/AuthToken.md +++ b/docs/nevermined-sdk/api-reference/interfaces/AuthToken.md @@ -6,14 +6,14 @@ ### Properties -- [access_token](AuthToken.md#access_token) +- [access\_token](AuthToken.md#access_token) ## Properties -### access_token +### access\_token -• **access_token**: `string` +• **access\_token**: `string` #### Defined in -[src/services/metadata/MetadataService.ts:34](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L34) +[src/services/metadata/MetadataService.ts:34](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L34) diff --git a/docs/nevermined-sdk/api-reference/interfaces/Authentication.md b/docs/nevermined-sdk/api-reference/interfaces/Authentication.md index c2c798ac41..e99952e420 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/Authentication.md +++ b/docs/nevermined-sdk/api-reference/interfaces/Authentication.md @@ -17,9 +17,9 @@ #### Defined in -[src/types/DDOTypes.ts:9](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L9) +[src/types/DDOTypes.ts:9](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L9) ---- +___ ### type @@ -27,4 +27,4 @@ #### Defined in -[src/types/DDOTypes.ts:8](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L8) +[src/types/DDOTypes.ts:8](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L8) diff --git a/docs/nevermined-sdk/api-reference/interfaces/Babysig.md b/docs/nevermined-sdk/api-reference/interfaces/Babysig.md index 09c6f47602..efcd6dd142 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/Babysig.md +++ b/docs/nevermined-sdk/api-reference/interfaces/Babysig.md @@ -17,9 +17,9 @@ #### Defined in -[src/types/GeneralTypes.ts:66](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L66) +[src/types/GeneralTypes.ts:66](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L66) ---- +___ ### S @@ -27,4 +27,4 @@ #### Defined in -[src/types/GeneralTypes.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L67) +[src/types/GeneralTypes.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L67) diff --git a/docs/nevermined-sdk/api-reference/interfaces/Balance.md b/docs/nevermined-sdk/api-reference/interfaces/Balance.md index e392506010..6d05456be4 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/Balance.md +++ b/docs/nevermined-sdk/api-reference/interfaces/Balance.md @@ -17,9 +17,9 @@ #### Defined in -[src/types/GeneralTypes.ts:71](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L71) +[src/types/GeneralTypes.ts:71](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L71) ---- +___ ### nevermined @@ -27,4 +27,4 @@ #### Defined in -[src/types/GeneralTypes.ts:72](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L72) +[src/types/GeneralTypes.ts:72](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L72) diff --git a/docs/nevermined-sdk/api-reference/interfaces/Bookmark.md b/docs/nevermined-sdk/api-reference/interfaces/Bookmark.md index cc9410c727..24cf20f22b 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/Bookmark.md +++ b/docs/nevermined-sdk/api-reference/interfaces/Bookmark.md @@ -26,9 +26,9 @@ #### Defined in -[src/types/MetadataTypes.ts:83](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L83) +[src/types/MetadataTypes.ts:83](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L83) ---- +___ ### description @@ -40,9 +40,9 @@ #### Defined in -[src/types/MetadataTypes.ts:78](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L78) +[src/types/MetadataTypes.ts:78](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L78) ---- +___ ### did @@ -54,9 +54,9 @@ #### Defined in -[src/types/MetadataTypes.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L76) +[src/types/MetadataTypes.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L76) ---- +___ ### id @@ -64,9 +64,9 @@ #### Defined in -[src/types/MetadataTypes.ts:82](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L82) +[src/types/MetadataTypes.ts:82](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L82) ---- +___ ### userId @@ -78,4 +78,4 @@ #### Defined in -[src/types/MetadataTypes.ts:77](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L77) +[src/types/MetadataTypes.ts:77](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L77) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ConditionData.md b/docs/nevermined-sdk/api-reference/interfaces/ConditionData.md index 4ec28bdc34..1eb85223a1 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ConditionData.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ConditionData.md @@ -22,9 +22,9 @@ #### Defined in -[src/keeper/contracts/managers/ConditionStoreManager.ts:13](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/ConditionStoreManager.ts#L13) +[src/keeper/contracts/managers/ConditionStoreManager.ts:13](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/ConditionStoreManager.ts#L13) ---- +___ ### blockNumberUpdated @@ -32,9 +32,9 @@ #### Defined in -[src/keeper/contracts/managers/ConditionStoreManager.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/ConditionStoreManager.ts#L15) +[src/keeper/contracts/managers/ConditionStoreManager.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/ConditionStoreManager.ts#L15) ---- +___ ### lastUpdatedBy @@ -42,9 +42,9 @@ #### Defined in -[src/keeper/contracts/managers/ConditionStoreManager.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/ConditionStoreManager.ts#L14) +[src/keeper/contracts/managers/ConditionStoreManager.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/ConditionStoreManager.ts#L14) ---- +___ ### state @@ -52,9 +52,9 @@ #### Defined in -[src/keeper/contracts/managers/ConditionStoreManager.ts:10](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/ConditionStoreManager.ts#L10) +[src/keeper/contracts/managers/ConditionStoreManager.ts:10](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/ConditionStoreManager.ts#L10) ---- +___ ### timeLock @@ -62,9 +62,9 @@ #### Defined in -[src/keeper/contracts/managers/ConditionStoreManager.ts:11](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/ConditionStoreManager.ts#L11) +[src/keeper/contracts/managers/ConditionStoreManager.ts:11](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/ConditionStoreManager.ts#L11) ---- +___ ### timeOut @@ -72,9 +72,9 @@ #### Defined in -[src/keeper/contracts/managers/ConditionStoreManager.ts:12](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/ConditionStoreManager.ts#L12) +[src/keeper/contracts/managers/ConditionStoreManager.ts:12](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/ConditionStoreManager.ts#L12) ---- +___ ### typeRef @@ -82,4 +82,4 @@ #### Defined in -[src/keeper/contracts/managers/ConditionStoreManager.ts:9](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/ConditionStoreManager.ts#L9) +[src/keeper/contracts/managers/ConditionStoreManager.ts:9](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/ConditionStoreManager.ts#L9) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ConditionInstanceSmall.md b/docs/nevermined-sdk/api-reference/interfaces/ConditionInstanceSmall.md index 70772878b0..0a315fc1a5 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ConditionInstanceSmall.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ConditionInstanceSmall.md @@ -20,9 +20,9 @@ #### Defined in -[src/types/ContractTypes.ts:33](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/ContractTypes.ts#L33) +[src/types/ContractTypes.ts:33](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/ContractTypes.ts#L33) ---- +___ ### condition @@ -30,9 +30,9 @@ #### Defined in -[src/types/ContractTypes.ts:34](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/ContractTypes.ts#L34) +[src/types/ContractTypes.ts:34](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/ContractTypes.ts#L34) ---- +___ ### id @@ -40,9 +40,9 @@ #### Defined in -[src/types/ContractTypes.ts:32](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/ContractTypes.ts#L32) +[src/types/ContractTypes.ts:32](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/ContractTypes.ts#L32) ---- +___ ### list @@ -50,9 +50,9 @@ #### Defined in -[src/types/ContractTypes.ts:30](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/ContractTypes.ts#L30) +[src/types/ContractTypes.ts:30](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/ContractTypes.ts#L30) ---- +___ ### seed @@ -60,4 +60,4 @@ #### Defined in -[src/types/ContractTypes.ts:31](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/ContractTypes.ts#L31) +[src/types/ContractTypes.ts:31](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/ContractTypes.ts#L31) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ContractEventSubscription.md b/docs/nevermined-sdk/api-reference/interfaces/ContractEventSubscription.md index 39ff513eac..964afc0002 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ContractEventSubscription.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ContractEventSubscription.md @@ -24,4 +24,4 @@ #### Defined in -[src/types/EventTypes.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/EventTypes.ts#L22) +[src/types/EventTypes.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/EventTypes.ts#L22) diff --git a/docs/nevermined-sdk/api-reference/interfaces/Curation.md b/docs/nevermined-sdk/api-reference/interfaces/Curation.md index 312f720a9b..951af65344 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/Curation.md +++ b/docs/nevermined-sdk/api-reference/interfaces/Curation.md @@ -33,9 +33,9 @@ true #### Defined in -[src/types/DDOTypes.ts:366](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L366) +[src/types/DDOTypes.ts:366](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L366) ---- +___ ### numVotes @@ -51,9 +51,9 @@ Number of votes. 0 is the default value. #### Defined in -[src/types/DDOTypes.ts:354](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L354) +[src/types/DDOTypes.ts:354](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L354) ---- +___ ### rating @@ -69,9 +69,9 @@ Decimal value between 0 and 1. 0 is the default value. #### Defined in -[src/types/DDOTypes.ts:348](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L348) +[src/types/DDOTypes.ts:348](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L348) ---- +___ ### schema @@ -82,9 +82,9 @@ Schema applied to calculate the rating. **`Example`** ```ts -'Binary Voting' +"Binary Voting" ``` #### Defined in -[src/types/DDOTypes.ts:360](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L360) +[src/types/DDOTypes.ts:360](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L360) diff --git a/docs/nevermined-sdk/api-reference/interfaces/DDOStatus.md b/docs/nevermined-sdk/api-reference/interfaces/DDOStatus.md index d6bcebb22e..3244cc3768 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/DDOStatus.md +++ b/docs/nevermined-sdk/api-reference/interfaces/DDOStatus.md @@ -17,18 +17,18 @@ #### Type declaration -| Name | Type | -| :------- | :------- | -| `id` | `string` | +| Name | Type | +| :------ | :------ | +| `id` | `string` | | `status` | `string` | -| `type` | `string` | -| `url` | `string` | +| `type` | `string` | +| `url` | `string` | #### Defined in -[src/services/metadata/MetadataService.ts:25](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L25) +[src/services/metadata/MetadataService.ts:25](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L25) ---- +___ ### internal @@ -36,13 +36,13 @@ #### Type declaration -| Name | Type | -| :------- | :------- | -| `id` | `string` | +| Name | Type | +| :------ | :------ | +| `id` | `string` | | `status` | `string` | -| `type` | `string` | -| `url` | `string` | +| `type` | `string` | +| `url` | `string` | #### Defined in -[src/services/metadata/MetadataService.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L19) +[src/services/metadata/MetadataService.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L19) diff --git a/docs/nevermined-sdk/api-reference/interfaces/Eip712Data.md b/docs/nevermined-sdk/api-reference/interfaces/Eip712Data.md index a571a330eb..09617d8294 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/Eip712Data.md +++ b/docs/nevermined-sdk/api-reference/interfaces/Eip712Data.md @@ -17,9 +17,9 @@ #### Defined in -[src/types/GeneralTypes.ts:77](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L77) +[src/types/GeneralTypes.ts:77](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L77) ---- +___ ### message @@ -27,4 +27,4 @@ #### Defined in -[src/types/GeneralTypes.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L76) +[src/types/GeneralTypes.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L76) diff --git a/docs/nevermined-sdk/api-reference/interfaces/EventEmitter.md b/docs/nevermined-sdk/api-reference/interfaces/EventEmitter.md index 81f3bf391a..3e2b04f1bc 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/EventEmitter.md +++ b/docs/nevermined-sdk/api-reference/interfaces/EventEmitter.md @@ -21,10 +21,10 @@ ##### Parameters -| Name | Type | -| :--------- | :-------------------------- | -| `callback` | () => `Promise`\<`void`\> | -| `arg1` | () => `Promise`\<`bigint`\> | +| Name | Type | +| :------ | :------ | +| `callback` | () => `Promise`\<`void`\> | +| `arg1` | () => `Promise`\<`bigint`\> | ##### Returns @@ -32,9 +32,9 @@ #### Defined in -[src/types/EventTypes.ts:17](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/EventTypes.ts#L17) +[src/types/EventTypes.ts:17](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/EventTypes.ts#L17) ---- +___ ### unsubscribe @@ -46,8 +46,8 @@ ##### Parameters -| Name | Type | -| :----- | :------------------------ | +| Name | Type | +| :------ | :------ | | `arg0` | () => `Promise`\<`void`\> | ##### Returns @@ -56,4 +56,4 @@ #### Defined in -[src/types/EventTypes.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/EventTypes.ts#L18) +[src/types/EventTypes.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/EventTypes.ts#L18) diff --git a/docs/nevermined-sdk/api-reference/interfaces/EventOptions.md b/docs/nevermined-sdk/api-reference/interfaces/EventOptions.md index 7cced6dd33..2ef248ec25 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/EventOptions.md +++ b/docs/nevermined-sdk/api-reference/interfaces/EventOptions.md @@ -21,9 +21,9 @@ #### Defined in -[src/types/EventTypes.ts:8](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/EventTypes.ts#L8) +[src/types/EventTypes.ts:8](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/EventTypes.ts#L8) ---- +___ ### filterJsonRpc @@ -31,9 +31,9 @@ #### Defined in -[src/types/EventTypes.ts:9](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/EventTypes.ts#L9) +[src/types/EventTypes.ts:9](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/EventTypes.ts#L9) ---- +___ ### filterSubgraph @@ -41,9 +41,9 @@ #### Defined in -[src/types/EventTypes.ts:10](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/EventTypes.ts#L10) +[src/types/EventTypes.ts:10](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/EventTypes.ts#L10) ---- +___ ### fromBlock @@ -51,9 +51,9 @@ #### Defined in -[src/types/EventTypes.ts:12](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/EventTypes.ts#L12) +[src/types/EventTypes.ts:12](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/EventTypes.ts#L12) ---- +___ ### result @@ -61,9 +61,9 @@ #### Defined in -[src/types/EventTypes.ts:11](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/EventTypes.ts#L11) +[src/types/EventTypes.ts:11](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/EventTypes.ts#L11) ---- +___ ### toBlock @@ -71,4 +71,4 @@ #### Defined in -[src/types/EventTypes.ts:13](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/EventTypes.ts#L13) +[src/types/EventTypes.ts:13](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/EventTypes.ts#L13) diff --git a/docs/nevermined-sdk/api-reference/interfaces/File.md b/docs/nevermined-sdk/api-reference/interfaces/File.md deleted file mode 100644 index 9ec4ae893e..0000000000 --- a/docs/nevermined-sdk/api-reference/interfaces/File.md +++ /dev/null @@ -1,173 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / File - -# Interface: File - -## Table of contents - -### Properties - -- [checksum](File.md#checksum) -- [checksumType](File.md#checksumtype) -- [compression](File.md#compression) -- [contentLength](File.md#contentlength) -- [contentType](File.md#contenttype) -- [encoding](File.md#encoding) -- [encryption](File.md#encryption) -- [index](File.md#index) -- [name](File.md#name) -- [resourceId](File.md#resourceid) -- [url](File.md#url) - -## Properties - -### checksum - -• `Optional` **checksum**: `string` - -File checksum. - -#### Defined in - -[src/ddo/MetaData.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L97) - -___ - -### checksumType - -• `Optional` **checksumType**: `string` - -Checksum hash algorithm. - -#### Defined in - -[src/ddo/MetaData.ts:102](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L102) - -___ - -### compression - -• `Optional` **compression**: `string` - -File compression (e.g. no, gzip, bzip2, etc). - -**`Example`** - -```ts -"zip" -``` - -#### Defined in - -[src/ddo/MetaData.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L124) - -___ - -### contentLength - -• `Optional` **contentLength**: `string` - -File content length. - -#### Defined in - -[src/ddo/MetaData.ts:107](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L107) - -___ - -### contentType - -• **contentType**: `string` - -File format, if applicable. - -**`Example`** - -```ts -"text/csv" -``` - -#### Defined in - -[src/ddo/MetaData.ts:92](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L92) - -___ - -### encoding - -• `Optional` **encoding**: `string` - -File encoding. - -**`Example`** - -```ts -"UTF-8" -``` - -#### Defined in - -[src/ddo/MetaData.ts:118](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L118) - -___ - -### encryption - -• `Optional` **encryption**: ``"dtp"`` - -Encryption mode used. - -**`Remarks`** - -If not provided is assumed the files are not encrypted. Currently only `dtp` is implemented. - -#### Defined in - -[src/ddo/MetaData.ts:132](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L132) - -___ - -### index - -• `Optional` **index**: `number` - -File index. - -#### Defined in - -[src/ddo/MetaData.ts:86](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L86) - -___ - -### name - -• `Optional` **name**: `string` - -File name. - -#### Defined in - -[src/ddo/MetaData.ts:76](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L76) - -___ - -### resourceId - -• `Optional` **resourceId**: `string` - -Resource ID (depending on the source). - -#### Defined in - -[src/ddo/MetaData.ts:112](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L112) - -___ - -### url - -• **url**: `string` - -File URL. - -#### Defined in - -[src/ddo/MetaData.ts:81](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L81) diff --git a/docs/nevermined-sdk/api-reference/interfaces/GenericAccess.md b/docs/nevermined-sdk/api-reference/interfaces/GenericAccess.md index 06b70cc0af..d19b090fb7 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/GenericAccess.md +++ b/docs/nevermined-sdk/api-reference/interfaces/GenericAccess.md @@ -22,7 +22,7 @@ #### Defined in -[src/keeper/contracts/templates/GenericAccess.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/GenericAccess.ts#L22) +[src/keeper/contracts/templates/GenericAccess.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/GenericAccess.ts#L22) ## Methods @@ -32,16 +32,16 @@ #### Parameters -| Name | Type | -| :----------------- | :------------------------------------------------------------------------------------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](../classes/DDO.md) | -| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | -| `parameters` | `any` | -| `consumer` | [`NvmAccount`](../classes/NvmAccount.md) | -| `from` | [`NvmAccount`](../classes/NvmAccount.md) | -| `txParams?` | [`TxParameters`](TxParameters.md) | -| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | +| Name | Type | +| :------ | :------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](../classes/DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `any` | +| `consumer` | [`NvmAccount`](../classes/NvmAccount.md) | +| `from` | [`NvmAccount`](../classes/NvmAccount.md) | +| `txParams?` | [`TxParameters`](TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | #### Returns @@ -49,29 +49,29 @@ #### Defined in -[src/keeper/contracts/templates/GenericAccess.ts:8](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/GenericAccess.ts#L8) +[src/keeper/contracts/templates/GenericAccess.ts:8](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/GenericAccess.ts#L8) ---- +___ ### getAgreementData -▸ **getAgreementData**(`agreementId`): `Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> +▸ **getAgreementData**(`agreementId`): `Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `agreementId` | `string` | #### Returns -`Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> +`Promise`\<\{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> #### Defined in -[src/keeper/contracts/templates/GenericAccess.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/GenericAccess.ts#L19) +[src/keeper/contracts/templates/GenericAccess.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/GenericAccess.ts#L19) ---- +___ ### params @@ -79,10 +79,10 @@ #### Parameters -| Name | Type | -| :--------- | :------ | -| `consumer` | `any` | -| `...args` | `any`[] | +| Name | Type | +| :------ | :------ | +| `consumer` | `any` | +| `...args` | `any`[] | #### Returns @@ -90,4 +90,4 @@ #### Defined in -[src/keeper/contracts/templates/GenericAccess.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/templates/GenericAccess.ts#L21) +[src/keeper/contracts/templates/GenericAccess.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/templates/GenericAccess.ts#L21) diff --git a/docs/nevermined-sdk/api-reference/interfaces/InputType.md b/docs/nevermined-sdk/api-reference/interfaces/InputType.md index 8b2975d716..cced82d696 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/InputType.md +++ b/docs/nevermined-sdk/api-reference/interfaces/InputType.md @@ -17,9 +17,9 @@ #### Defined in -[src/types/GeneralTypes.ts:10](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L10) +[src/types/GeneralTypes.ts:10](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L10) ---- +___ ### type @@ -27,4 +27,4 @@ #### Defined in -[src/types/GeneralTypes.ts:11](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L11) +[src/types/GeneralTypes.ts:11](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L11) diff --git a/docs/nevermined-sdk/api-reference/interfaces/InstantiableConfig.md b/docs/nevermined-sdk/api-reference/interfaces/InstantiableConfig.md index 53ed61d360..cdb8513277 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/InstantiableConfig.md +++ b/docs/nevermined-sdk/api-reference/interfaces/InstantiableConfig.md @@ -21,9 +21,9 @@ #### Defined in -[src/Instantiable.abstract.ts:19](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L19) +[src/Instantiable.abstract.ts:19](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L19) ---- +___ ### circuitsFolder @@ -31,9 +31,9 @@ #### Defined in -[src/Instantiable.abstract.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L20) +[src/Instantiable.abstract.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L20) ---- +___ ### client @@ -41,9 +41,9 @@ #### Defined in -[src/Instantiable.abstract.ts:17](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L17) +[src/Instantiable.abstract.ts:17](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L17) ---- +___ ### config @@ -51,9 +51,9 @@ #### Defined in -[src/Instantiable.abstract.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L16) +[src/Instantiable.abstract.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L16) ---- +___ ### logger @@ -61,9 +61,9 @@ #### Defined in -[src/Instantiable.abstract.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L18) +[src/Instantiable.abstract.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L18) ---- +___ ### nevermined @@ -71,4 +71,4 @@ #### Defined in -[src/Instantiable.abstract.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L15) +[src/Instantiable.abstract.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L15) diff --git a/docs/nevermined-sdk/api-reference/interfaces/KeyTransfer.Babysig.md b/docs/nevermined-sdk/api-reference/interfaces/KeyTransfer.Babysig.md deleted file mode 100644 index 4525f9711c..0000000000 --- a/docs/nevermined-sdk/api-reference/interfaces/KeyTransfer.Babysig.md +++ /dev/null @@ -1,32 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [KeyTransfer](../modules/KeyTransfer.md) / Babysig - -# Interface: Babysig - -[KeyTransfer](../modules/KeyTransfer.md).Babysig - -## Table of contents - -### Properties - -- [R8](KeyTransfer.Babysig.md#r8) -- [S](KeyTransfer.Babysig.md#s) - -## Properties - -### R8 - -• **R8**: [`string`, `string`] - -#### Defined in - -[src/models/KeyTransfer.ts:34](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L34) - -___ - -### S - -• **S**: `string` - -#### Defined in - -[src/models/KeyTransfer.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L35) diff --git a/docs/nevermined-sdk/api-reference/interfaces/MarketplaceResults.md b/docs/nevermined-sdk/api-reference/interfaces/MarketplaceResults.md index 24d8d68f3f..a528fc9bdf 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/MarketplaceResults.md +++ b/docs/nevermined-sdk/api-reference/interfaces/MarketplaceResults.md @@ -4,8 +4,8 @@ ## Type parameters -| Name | -| :------- | +| Name | +| :------ | | `Entity` | ## Table of contents @@ -14,8 +14,8 @@ - [page](MarketplaceResults.md#page) - [results](MarketplaceResults.md#results) -- [total_pages](MarketplaceResults.md#total_pages) -- [total_results](MarketplaceResults.md#total_results) +- [total\_pages](MarketplaceResults.md#total_pages) +- [total\_results](MarketplaceResults.md#total_results) ## Properties @@ -25,9 +25,9 @@ #### Defined in -[src/types/MetadataTypes.ts:59](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L59) +[src/types/MetadataTypes.ts:59](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L59) ---- +___ ### results @@ -35,24 +35,24 @@ #### Defined in -[src/types/MetadataTypes.ts:60](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L60) +[src/types/MetadataTypes.ts:60](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L60) ---- +___ -### total_pages +### total\_pages -• **total_pages**: `number` +• **total\_pages**: `number` #### Defined in -[src/types/MetadataTypes.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L61) +[src/types/MetadataTypes.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L61) ---- +___ -### total_results +### total\_results -• **total_results**: [`SearchResults`](SearchResults.md) +• **total\_results**: [`SearchResults`](SearchResults.md) #### Defined in -[src/types/MetadataTypes.ts:62](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L62) +[src/types/MetadataTypes.ts:62](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L62) diff --git a/docs/nevermined-sdk/api-reference/interfaces/MetaData.md b/docs/nevermined-sdk/api-reference/interfaces/MetaData.md index 9e8c82284f..4fcd2f16b5 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/MetaData.md +++ b/docs/nevermined-sdk/api-reference/interfaces/MetaData.md @@ -20,9 +20,9 @@ #### Defined in -[src/types/DDOTypes.ts:486](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L486) +[src/types/DDOTypes.ts:486](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L486) ---- +___ ### curation @@ -30,9 +30,9 @@ #### Defined in -[src/types/DDOTypes.ts:487](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L487) +[src/types/DDOTypes.ts:487](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L487) ---- +___ ### encryptedFiles @@ -40,9 +40,9 @@ #### Defined in -[src/types/DDOTypes.ts:485](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L485) +[src/types/DDOTypes.ts:485](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L485) ---- +___ ### main @@ -50,9 +50,9 @@ #### Defined in -[src/types/DDOTypes.ts:484](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L484) +[src/types/DDOTypes.ts:484](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L484) ---- +___ ### userId @@ -60,4 +60,4 @@ #### Defined in -[src/types/DDOTypes.ts:483](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L483) +[src/types/DDOTypes.ts:483](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L483) diff --git a/docs/nevermined-sdk/api-reference/interfaces/MetaDataExternalResource.md b/docs/nevermined-sdk/api-reference/interfaces/MetaDataExternalResource.md index e6dc77e45b..65acf47d8c 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/MetaDataExternalResource.md +++ b/docs/nevermined-sdk/api-reference/interfaces/MetaDataExternalResource.md @@ -29,9 +29,9 @@ File checksum. #### Defined in -[src/types/DDOTypes.ts:148](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L148) +[src/types/DDOTypes.ts:148](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L148) ---- +___ ### checksumType @@ -41,9 +41,9 @@ Checksum hash algorithm. #### Defined in -[src/types/DDOTypes.ts:153](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L153) +[src/types/DDOTypes.ts:153](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L153) ---- +___ ### compression @@ -54,14 +54,14 @@ File compression (e.g. no, gzip, bzip2, etc). **`Example`** ```ts -'zip' +"zip" ``` #### Defined in -[src/types/DDOTypes.ts:181](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L181) +[src/types/DDOTypes.ts:181](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L181) ---- +___ ### contentLength @@ -71,9 +71,9 @@ File content length. #### Defined in -[src/types/DDOTypes.ts:158](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L158) +[src/types/DDOTypes.ts:158](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L158) ---- +___ ### contentType @@ -84,14 +84,14 @@ File format, if applicable. **`Example`** ```ts -'text/csv' +"text/csv" ``` #### Defined in -[src/types/DDOTypes.ts:143](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L143) +[src/types/DDOTypes.ts:143](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L143) ---- +___ ### encoding @@ -102,18 +102,18 @@ File encoding. **`Example`** ```ts -'UTF-8' +"UTF-8" ``` #### Defined in -[src/types/DDOTypes.ts:175](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L175) +[src/types/DDOTypes.ts:175](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L175) ---- +___ ### encryption -• `Optional` **encryption**: `"dtp"` \| `"dleq"` +• `Optional` **encryption**: ``"dtp"`` \| ``"dleq"`` Encryption mode used. @@ -123,9 +123,9 @@ If not provided is assumed the files are not encrypted. Currently only `dtp` is #### Defined in -[src/types/DDOTypes.ts:189](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L189) +[src/types/DDOTypes.ts:189](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L189) ---- +___ ### index @@ -135,9 +135,9 @@ File index. #### Defined in -[src/types/DDOTypes.ts:137](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L137) +[src/types/DDOTypes.ts:137](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L137) ---- +___ ### name @@ -147,9 +147,9 @@ File name. #### Defined in -[src/types/DDOTypes.ts:127](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L127) +[src/types/DDOTypes.ts:127](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L127) ---- +___ ### resourceId @@ -160,9 +160,9 @@ For example the `ugcId` #### Defined in -[src/types/DDOTypes.ts:169](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L169) +[src/types/DDOTypes.ts:169](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L169) ---- +___ ### resourceType @@ -172,9 +172,9 @@ The type of the external resource file #### Defined in -[src/types/DDOTypes.ts:163](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L163) +[src/types/DDOTypes.ts:163](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L163) ---- +___ ### url @@ -184,4 +184,4 @@ File URL. #### Defined in -[src/types/DDOTypes.ts:132](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L132) +[src/types/DDOTypes.ts:132](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L132) diff --git a/docs/nevermined-sdk/api-reference/interfaces/MetaDataMain.md b/docs/nevermined-sdk/api-reference/interfaces/MetaDataMain.md index ed20410758..23a4681081 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/MetaDataMain.md +++ b/docs/nevermined-sdk/api-reference/interfaces/MetaDataMain.md @@ -41,9 +41,9 @@ https://github.com/nevermined-io/docs/blob/master/docs/architecture/specs/metada #### Defined in -[src/types/DDOTypes.ts:326](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L326) +[src/types/DDOTypes.ts:326](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L326) ---- +___ ### author @@ -54,14 +54,14 @@ Name of the entity generating this data (e.g. Tfl, Disney Corp, etc.). **`Example`** ```ts -'Met Office' +"Met Office" ``` #### Defined in -[src/types/DDOTypes.ts:304](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L304) +[src/types/DDOTypes.ts:304](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L304) ---- +___ ### dateCreated @@ -73,14 +73,14 @@ ISO 8601 format, Coordinated Universal Time. **`Example`** ```ts -'2019-01-31T08:38:32Z' +"2019-01-31T08:38:32Z" ``` #### Defined in -[src/types/DDOTypes.ts:280](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L280) +[src/types/DDOTypes.ts:280](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L280) ---- +___ ### datePublished @@ -93,14 +93,14 @@ so this value can't be set. **`Example`** ```ts -'2019-01-31T08:38:32Z' +"2019-01-31T08:38:32Z" ``` #### Defined in -[src/types/DDOTypes.ts:288](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L288) +[src/types/DDOTypes.ts:288](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L288) ---- +___ ### encryptedService @@ -108,9 +108,9 @@ so this value can't be set. #### Defined in -[src/types/DDOTypes.ts:322](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L322) +[src/types/DDOTypes.ts:322](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L322) ---- +___ ### ercType @@ -118,9 +118,9 @@ so this value can't be set. #### Defined in -[src/types/DDOTypes.ts:330](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L330) +[src/types/DDOTypes.ts:330](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L330) ---- +___ ### files @@ -130,9 +130,9 @@ Array of File objects including the encrypted file urls and some additional info #### Defined in -[src/types/DDOTypes.ts:316](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L316) +[src/types/DDOTypes.ts:316](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L316) ---- +___ ### isDTP @@ -140,9 +140,9 @@ Array of File objects including the encrypted file urls and some additional info #### Defined in -[src/types/DDOTypes.ts:334](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L334) +[src/types/DDOTypes.ts:334](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L334) ---- +___ ### license @@ -154,14 +154,14 @@ If it's not specified, the following value will be added: "No License Specified" **`Example`** ```ts -'CC-BY' +"CC-BY" ``` #### Defined in -[src/types/DDOTypes.ts:311](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L311) +[src/types/DDOTypes.ts:311](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L311) ---- +___ ### name @@ -172,14 +172,14 @@ Descriptive name of the Asset. **`Example`** ```ts -'UK Weather information 2011' +"UK Weather information 2011" ``` #### Defined in -[src/types/DDOTypes.ts:249](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L249) +[src/types/DDOTypes.ts:249](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L249) ---- +___ ### nftType @@ -187,9 +187,9 @@ Descriptive name of the Asset. #### Defined in -[src/types/DDOTypes.ts:332](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L332) +[src/types/DDOTypes.ts:332](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L332) ---- +___ ### nonce @@ -197,9 +197,9 @@ Descriptive name of the Asset. #### Defined in -[src/types/DDOTypes.ts:298](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L298) +[src/types/DDOTypes.ts:298](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L298) ---- +___ ### paymentAttributes @@ -207,9 +207,9 @@ Descriptive name of the Asset. #### Defined in -[src/types/DDOTypes.ts:336](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L336) +[src/types/DDOTypes.ts:336](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L336) ---- +___ ### service @@ -217,9 +217,9 @@ Descriptive name of the Asset. #### Defined in -[src/types/DDOTypes.ts:328](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L328) +[src/types/DDOTypes.ts:328](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L328) ---- +___ ### subType @@ -231,9 +231,9 @@ Another example, if the type is 'dataset' the subtype could be 'tabular', 'parqu #### Defined in -[src/types/DDOTypes.ts:273](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L273) +[src/types/DDOTypes.ts:273](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L273) ---- +___ ### subscription @@ -241,13 +241,13 @@ Another example, if the type is 'dataset' the subtype could be 'tabular', 'parqu #### Defined in -[src/types/DDOTypes.ts:318](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L318) +[src/types/DDOTypes.ts:318](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L318) ---- +___ ### type -• **type**: `"compute"` \| `"workflow"` \| `"service"` \| `"dataset"` \| `"algorithm"` \| `"subscription"` \| `"model"` \| `"file"` \| `"other"` \| `"assistant"` +• **type**: ``"compute"`` \| ``"workflow"`` \| ``"service"`` \| ``"dataset"`` \| ``"algorithm"`` \| ``"subscription"`` \| ``"model"`` \| ``"file"`` \| ``"other"`` \| ``"assistant"`` Type of the Asset. Helps to filter by the type of asset, initially ("dataset", "algorithm", "compute", "workflow", "model", "file", "subscription", "other"). @@ -255,14 +255,14 @@ initially ("dataset", "algorithm", "compute", "workflow", "model", "file", "subs **`Example`** ```ts -'dataset' +"dataset" ``` #### Defined in -[src/types/DDOTypes.ts:256](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L256) +[src/types/DDOTypes.ts:256](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L256) ---- +___ ### updatedAt @@ -275,14 +275,14 @@ so this value can't be set. **`Example`** ```ts -'2019-01-31T08:38:32Z' +"2019-01-31T08:38:32Z" ``` #### Defined in -[src/types/DDOTypes.ts:296](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L296) +[src/types/DDOTypes.ts:296](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L296) ---- +___ ### webService @@ -290,9 +290,9 @@ so this value can't be set. #### Defined in -[src/types/DDOTypes.ts:320](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L320) +[src/types/DDOTypes.ts:320](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L320) ---- +___ ### workflow @@ -300,4 +300,4 @@ so this value can't be set. #### Defined in -[src/types/DDOTypes.ts:324](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L324) +[src/types/DDOTypes.ts:324](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L324) diff --git a/docs/nevermined-sdk/api-reference/interfaces/MetadataValidationResults.md b/docs/nevermined-sdk/api-reference/interfaces/MetadataValidationResults.md index 681943405f..a661b3b17e 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/MetadataValidationResults.md +++ b/docs/nevermined-sdk/api-reference/interfaces/MetadataValidationResults.md @@ -17,9 +17,9 @@ #### Defined in -[src/nevermined/NvmApp.ts:49](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L49) +[src/nevermined/NvmApp.ts:49](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L49) ---- +___ ### messages @@ -27,4 +27,4 @@ #### Defined in -[src/nevermined/NvmApp.ts:50](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L50) +[src/nevermined/NvmApp.ts:50](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L50) diff --git a/docs/nevermined-sdk/api-reference/interfaces/MethodReflection.md b/docs/nevermined-sdk/api-reference/interfaces/MethodReflection.md index 44f7ee2a9c..8c49b3f20e 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/MethodReflection.md +++ b/docs/nevermined-sdk/api-reference/interfaces/MethodReflection.md @@ -20,9 +20,9 @@ #### Defined in -[src/types/GeneralTypes.ts:60](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L60) +[src/types/GeneralTypes.ts:60](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L60) ---- +___ ### contractName @@ -30,9 +30,9 @@ #### Defined in -[src/types/GeneralTypes.ts:58](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L58) +[src/types/GeneralTypes.ts:58](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L58) ---- +___ ### inputs @@ -40,9 +40,9 @@ #### Defined in -[src/types/GeneralTypes.ts:62](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L62) +[src/types/GeneralTypes.ts:62](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L62) ---- +___ ### methodName @@ -50,9 +50,9 @@ #### Defined in -[src/types/GeneralTypes.ts:59](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L59) +[src/types/GeneralTypes.ts:59](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L59) ---- +___ ### signature @@ -60,4 +60,4 @@ #### Defined in -[src/types/GeneralTypes.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L61) +[src/types/GeneralTypes.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L61) diff --git a/docs/nevermined-sdk/api-reference/interfaces/NFT1155MintedEntry.md b/docs/nevermined-sdk/api-reference/interfaces/NFT1155MintedEntry.md index a6d90e75a9..cb3bb4242c 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/NFT1155MintedEntry.md +++ b/docs/nevermined-sdk/api-reference/interfaces/NFT1155MintedEntry.md @@ -18,9 +18,9 @@ #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L15) +[src/keeper/contracts/NFTContractsBase.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L15) ---- +___ ### expirationBlock @@ -28,9 +28,9 @@ #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L16) +[src/keeper/contracts/NFTContractsBase.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L16) ---- +___ ### mintBlock @@ -38,4 +38,4 @@ #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:17](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L17) +[src/keeper/contracts/NFTContractsBase.ts:17](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L17) diff --git a/docs/nevermined-sdk/api-reference/interfaces/NFT721MintedEntry.md b/docs/nevermined-sdk/api-reference/interfaces/NFT721MintedEntry.md index 22e081595d..196f7c7dc1 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/NFT721MintedEntry.md +++ b/docs/nevermined-sdk/api-reference/interfaces/NFT721MintedEntry.md @@ -18,9 +18,9 @@ #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:10](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L10) +[src/keeper/contracts/NFTContractsBase.ts:10](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L10) ---- +___ ### mintBlock @@ -28,9 +28,9 @@ #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:11](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L11) +[src/keeper/contracts/NFTContractsBase.ts:11](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L11) ---- +___ ### tokenId @@ -38,4 +38,4 @@ #### Defined in -[src/keeper/contracts/NFTContractsBase.ts:9](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/NFTContractsBase.ts#L9) +[src/keeper/contracts/NFTContractsBase.ts:9](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/NFTContractsBase.ts#L9) diff --git a/docs/nevermined-sdk/api-reference/interfaces/NeverminedInitializationOptions.md b/docs/nevermined-sdk/api-reference/interfaces/NeverminedInitializationOptions.md index eb0bf8659c..0be51ab7fc 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/NeverminedInitializationOptions.md +++ b/docs/nevermined-sdk/api-reference/interfaces/NeverminedInitializationOptions.md @@ -26,9 +26,9 @@ #### Defined in -[src/types/GeneralTypes.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L100) +[src/types/GeneralTypes.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L100) ---- +___ ### loadCompute @@ -36,9 +36,9 @@ #### Defined in -[src/types/GeneralTypes.ts:104](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L104) +[src/types/GeneralTypes.ts:104](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L104) ---- +___ ### loadCore @@ -46,9 +46,9 @@ #### Defined in -[src/types/GeneralTypes.ts:94](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L94) +[src/types/GeneralTypes.ts:94](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L94) ---- +___ ### loadDIDTransferFlow @@ -56,9 +56,9 @@ #### Defined in -[src/types/GeneralTypes.ts:101](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L101) +[src/types/GeneralTypes.ts:101](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L101) ---- +___ ### loadDispenser @@ -66,9 +66,9 @@ #### Defined in -[src/types/GeneralTypes.ts:98](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L98) +[src/types/GeneralTypes.ts:98](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L98) ---- +___ ### loadERC20Token @@ -76,9 +76,9 @@ #### Defined in -[src/types/GeneralTypes.ts:99](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L99) +[src/types/GeneralTypes.ts:99](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L99) ---- +___ ### loadNFTs1155 @@ -86,9 +86,9 @@ #### Defined in -[src/types/GeneralTypes.ts:97](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L97) +[src/types/GeneralTypes.ts:97](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L97) ---- +___ ### loadNFTs721 @@ -96,9 +96,9 @@ #### Defined in -[src/types/GeneralTypes.ts:96](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L96) +[src/types/GeneralTypes.ts:96](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L96) ---- +___ ### loadRewards @@ -106,9 +106,9 @@ #### Defined in -[src/types/GeneralTypes.ts:102](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L102) +[src/types/GeneralTypes.ts:102](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L102) ---- +___ ### loadRoyalties @@ -116,9 +116,9 @@ #### Defined in -[src/types/GeneralTypes.ts:103](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L103) +[src/types/GeneralTypes.ts:103](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L103) ---- +___ ### loadServiceAgreements @@ -126,4 +126,4 @@ #### Defined in -[src/types/GeneralTypes.ts:95](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L95) +[src/types/GeneralTypes.ts:95](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L95) diff --git a/docs/nevermined-sdk/api-reference/interfaces/NewBookmark.md b/docs/nevermined-sdk/api-reference/interfaces/NewBookmark.md index cc948fb199..dbda96dfa1 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/NewBookmark.md +++ b/docs/nevermined-sdk/api-reference/interfaces/NewBookmark.md @@ -24,9 +24,9 @@ #### Defined in -[src/types/MetadataTypes.ts:78](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L78) +[src/types/MetadataTypes.ts:78](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L78) ---- +___ ### did @@ -34,9 +34,9 @@ #### Defined in -[src/types/MetadataTypes.ts:76](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L76) +[src/types/MetadataTypes.ts:76](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L76) ---- +___ ### userId @@ -44,4 +44,4 @@ #### Defined in -[src/types/MetadataTypes.ts:77](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L77) +[src/types/MetadataTypes.ts:77](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L77) diff --git a/docs/nevermined-sdk/api-reference/interfaces/NewPermission.md b/docs/nevermined-sdk/api-reference/interfaces/NewPermission.md index 23ecaa4f09..95560d7ed3 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/NewPermission.md +++ b/docs/nevermined-sdk/api-reference/interfaces/NewPermission.md @@ -25,9 +25,9 @@ #### Defined in -[src/types/MetadataTypes.ts:97](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L97) +[src/types/MetadataTypes.ts:97](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L97) ---- +___ ### issuer @@ -35,9 +35,9 @@ #### Defined in -[src/types/MetadataTypes.ts:96](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L96) +[src/types/MetadataTypes.ts:96](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L96) ---- +___ ### type @@ -45,9 +45,9 @@ #### Defined in -[src/types/MetadataTypes.ts:95](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L95) +[src/types/MetadataTypes.ts:95](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L95) ---- +___ ### userId @@ -55,4 +55,4 @@ #### Defined in -[src/types/MetadataTypes.ts:94](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L94) +[src/types/MetadataTypes.ts:94](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L94) diff --git a/docs/nevermined-sdk/api-reference/interfaces/NewProfile.md b/docs/nevermined-sdk/api-reference/interfaces/NewProfile.md index bf35a58615..dedf8ca898 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/NewProfile.md +++ b/docs/nevermined-sdk/api-reference/interfaces/NewProfile.md @@ -28,9 +28,9 @@ #### Defined in -[src/types/MetadataTypes.ts:118](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L118) +[src/types/MetadataTypes.ts:118](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L118) ---- +___ ### addresses @@ -38,9 +38,9 @@ #### Defined in -[src/types/MetadataTypes.ts:114](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L114) +[src/types/MetadataTypes.ts:114](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L114) ---- +___ ### email @@ -48,9 +48,9 @@ #### Defined in -[src/types/MetadataTypes.ts:117](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L117) +[src/types/MetadataTypes.ts:117](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L117) ---- +___ ### isListed @@ -58,9 +58,9 @@ #### Defined in -[src/types/MetadataTypes.ts:112](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L112) +[src/types/MetadataTypes.ts:112](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L112) ---- +___ ### name @@ -68,9 +68,9 @@ #### Defined in -[src/types/MetadataTypes.ts:116](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L116) +[src/types/MetadataTypes.ts:116](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L116) ---- +___ ### nickname @@ -78,9 +78,9 @@ #### Defined in -[src/types/MetadataTypes.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L115) +[src/types/MetadataTypes.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L115) ---- +___ ### state @@ -88,4 +88,4 @@ #### Defined in -[src/types/MetadataTypes.ts:113](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L113) +[src/types/MetadataTypes.ts:113](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L113) diff --git a/docs/nevermined-sdk/api-reference/interfaces/NvmConfig.md b/docs/nevermined-sdk/api-reference/interfaces/NvmConfig.md index 5c34a489c7..0fcd20b78c 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/NvmConfig.md +++ b/docs/nevermined-sdk/api-reference/interfaces/NvmConfig.md @@ -50,9 +50,9 @@ apps using the same marketplace api #### Defined in -[src/types/DDOTypes.ts:559](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L559) +[src/types/DDOTypes.ts:559](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L559) ---- +___ ### networks @@ -66,9 +66,9 @@ Block networks where the asset is available. It is represented as a map of netwo #### Defined in -[src/types/DDOTypes.ts:568](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L568) +[src/types/DDOTypes.ts:568](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L568) ---- +___ ### userId @@ -82,9 +82,9 @@ Used to identify a user in the marketplace api #### Defined in -[src/types/DDOTypes.ts:550](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L550) +[src/types/DDOTypes.ts:550](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L550) ---- +___ ### versions @@ -94,4 +94,4 @@ The `versions` list stores the reference to all the changes done to the Metadata #### Defined in -[src/types/DDOTypes.ts:563](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L563) +[src/types/DDOTypes.ts:563](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L563) diff --git a/docs/nevermined-sdk/api-reference/interfaces/NvmConfigVersions.md b/docs/nevermined-sdk/api-reference/interfaces/NvmConfigVersions.md index c8b7c0ff98..b3e8dd7e8f 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/NvmConfigVersions.md +++ b/docs/nevermined-sdk/api-reference/interfaces/NvmConfigVersions.md @@ -22,9 +22,9 @@ The checksum of the document #### Defined in -[src/types/DDOTypes.ts:593](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L593) +[src/types/DDOTypes.ts:593](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L593) ---- +___ ### id @@ -38,9 +38,9 @@ This is a self incrementing number #### Defined in -[src/types/DDOTypes.ts:585](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L585) +[src/types/DDOTypes.ts:585](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L585) ---- +___ ### immutableBackend @@ -50,9 +50,9 @@ The immutable solution to record the DDO #### Defined in -[src/types/DDOTypes.ts:603](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L603) +[src/types/DDOTypes.ts:603](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L603) ---- +___ ### immutableUrl @@ -62,9 +62,9 @@ ID Hash of the metadata recorded in an immutable data store (IPFS, Filecoin, Arw #### Defined in -[src/types/DDOTypes.ts:598](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L598) +[src/types/DDOTypes.ts:598](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L598) ---- +___ ### updated @@ -74,4 +74,4 @@ The date when the update occurred. #### Defined in -[src/types/DDOTypes.ts:589](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L589) +[src/types/DDOTypes.ts:589](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L589) diff --git a/docs/nevermined-sdk/api-reference/interfaces/OperationResult.md b/docs/nevermined-sdk/api-reference/interfaces/OperationResult.md index 5975652a30..7c665b28c1 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/OperationResult.md +++ b/docs/nevermined-sdk/api-reference/interfaces/OperationResult.md @@ -17,9 +17,9 @@ #### Defined in -[src/nevermined/NvmApp.ts:54](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L54) +[src/nevermined/NvmApp.ts:54](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L54) ---- +___ ### success @@ -27,4 +27,4 @@ #### Defined in -[src/nevermined/NvmApp.ts:55](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L55) +[src/nevermined/NvmApp.ts:55](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L55) diff --git a/docs/nevermined-sdk/api-reference/interfaces/PaymentAttributes.md b/docs/nevermined-sdk/api-reference/interfaces/PaymentAttributes.md index 8695fe9db1..aee2fc5ecb 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/PaymentAttributes.md +++ b/docs/nevermined-sdk/api-reference/interfaces/PaymentAttributes.md @@ -22,9 +22,9 @@ #### Defined in -[src/types/DDOTypes.ts:69](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L69) +[src/types/DDOTypes.ts:69](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L69) ---- +___ ### paymentEnabled @@ -32,14 +32,14 @@ #### Defined in -[src/types/DDOTypes.ts:68](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L68) +[src/types/DDOTypes.ts:68](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L68) ---- +___ ### paymentType -• **paymentType**: `"serviceAgreements"` \| `"stripe"` +• **paymentType**: ``"serviceAgreements"`` \| ``"stripe"`` #### Defined in -[src/types/DDOTypes.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L67) +[src/types/DDOTypes.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L67) diff --git a/docs/nevermined-sdk/api-reference/interfaces/PaymentData.md b/docs/nevermined-sdk/api-reference/interfaces/PaymentData.md index 2014228e95..d2148eca95 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/PaymentData.md +++ b/docs/nevermined-sdk/api-reference/interfaces/PaymentData.md @@ -19,9 +19,9 @@ #### Defined in -[src/types/ContractTypes.ts:25](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/ContractTypes.ts#L25) +[src/types/ContractTypes.ts:25](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/ContractTypes.ts#L25) ---- +___ ### receivers @@ -29,9 +29,9 @@ #### Defined in -[src/types/ContractTypes.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/ContractTypes.ts#L26) +[src/types/ContractTypes.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/ContractTypes.ts#L26) ---- +___ ### rewardAddress @@ -39,9 +39,9 @@ #### Defined in -[src/types/ContractTypes.ts:23](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/ContractTypes.ts#L23) +[src/types/ContractTypes.ts:23](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/ContractTypes.ts#L23) ---- +___ ### tokenAddress @@ -49,4 +49,4 @@ #### Defined in -[src/types/ContractTypes.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/ContractTypes.ts#L24) +[src/types/ContractTypes.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/ContractTypes.ts#L24) diff --git a/docs/nevermined-sdk/api-reference/interfaces/Permission.md b/docs/nevermined-sdk/api-reference/interfaces/Permission.md index bfd6bef84a..f863b3fcba 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/Permission.md +++ b/docs/nevermined-sdk/api-reference/interfaces/Permission.md @@ -31,9 +31,9 @@ #### Defined in -[src/types/MetadataTypes.ts:97](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L97) +[src/types/MetadataTypes.ts:97](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L97) ---- +___ ### id @@ -41,9 +41,9 @@ #### Defined in -[src/types/MetadataTypes.ts:101](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L101) +[src/types/MetadataTypes.ts:101](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L101) ---- +___ ### issuanceDate @@ -51,9 +51,9 @@ #### Defined in -[src/types/MetadataTypes.ts:102](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L102) +[src/types/MetadataTypes.ts:102](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L102) ---- +___ ### issuer @@ -65,9 +65,9 @@ #### Defined in -[src/types/MetadataTypes.ts:96](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L96) +[src/types/MetadataTypes.ts:96](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L96) ---- +___ ### type @@ -79,9 +79,9 @@ #### Defined in -[src/types/MetadataTypes.ts:95](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L95) +[src/types/MetadataTypes.ts:95](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L95) ---- +___ ### userId @@ -93,4 +93,4 @@ #### Defined in -[src/types/MetadataTypes.ts:94](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L94) +[src/types/MetadataTypes.ts:94](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L94) diff --git a/docs/nevermined-sdk/api-reference/interfaces/PlatformKeeperTech.md b/docs/nevermined-sdk/api-reference/interfaces/PlatformKeeperTech.md index b8feee43e4..d93f1d9256 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/PlatformKeeperTech.md +++ b/docs/nevermined-sdk/api-reference/interfaces/PlatformKeeperTech.md @@ -33,9 +33,9 @@ #### Defined in -[src/nevermined/Versions.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L15) +[src/nevermined/Versions.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L15) ---- +___ ### contracts @@ -47,9 +47,9 @@ #### Defined in -[src/nevermined/Versions.ts:22](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L22) +[src/nevermined/Versions.ts:22](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L22) ---- +___ ### keeperVersion @@ -57,9 +57,9 @@ #### Defined in -[src/nevermined/Versions.ts:21](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L21) +[src/nevermined/Versions.ts:21](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L21) ---- +___ ### name @@ -71,9 +71,9 @@ #### Defined in -[src/nevermined/Versions.ts:13](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L13) +[src/nevermined/Versions.ts:13](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L13) ---- +___ ### network @@ -81,9 +81,9 @@ #### Defined in -[src/nevermined/Versions.ts:20](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L20) +[src/nevermined/Versions.ts:20](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L20) ---- +___ ### providerAddress @@ -91,9 +91,9 @@ #### Defined in -[src/nevermined/Versions.ts:23](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L23) +[src/nevermined/Versions.ts:23](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L23) ---- +___ ### status @@ -105,9 +105,9 @@ #### Defined in -[src/nevermined/Versions.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L16) +[src/nevermined/Versions.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L16) ---- +___ ### version @@ -119,4 +119,4 @@ #### Defined in -[src/nevermined/Versions.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L14) +[src/nevermined/Versions.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L14) diff --git a/docs/nevermined-sdk/api-reference/interfaces/PlatformTech.md b/docs/nevermined-sdk/api-reference/interfaces/PlatformTech.md index 856eb778f4..7edb26811e 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/PlatformTech.md +++ b/docs/nevermined-sdk/api-reference/interfaces/PlatformTech.md @@ -25,9 +25,9 @@ #### Defined in -[src/nevermined/Versions.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L15) +[src/nevermined/Versions.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L15) ---- +___ ### name @@ -35,9 +35,9 @@ #### Defined in -[src/nevermined/Versions.ts:13](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L13) +[src/nevermined/Versions.ts:13](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L13) ---- +___ ### status @@ -45,9 +45,9 @@ #### Defined in -[src/nevermined/Versions.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L16) +[src/nevermined/Versions.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L16) ---- +___ ### version @@ -55,4 +55,4 @@ #### Defined in -[src/nevermined/Versions.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L14) +[src/nevermined/Versions.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L14) diff --git a/docs/nevermined-sdk/api-reference/interfaces/PlatformVersions.md b/docs/nevermined-sdk/api-reference/interfaces/PlatformVersions.md index a4352853ac..c575bedfdd 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/PlatformVersions.md +++ b/docs/nevermined-sdk/api-reference/interfaces/PlatformVersions.md @@ -19,9 +19,9 @@ #### Defined in -[src/nevermined/Versions.ts:28](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L28) +[src/nevermined/Versions.ts:28](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L28) ---- +___ ### node @@ -29,9 +29,9 @@ #### Defined in -[src/nevermined/Versions.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L29) +[src/nevermined/Versions.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L29) ---- +___ ### sdk @@ -39,9 +39,9 @@ #### Defined in -[src/nevermined/Versions.ts:27](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L27) +[src/nevermined/Versions.ts:27](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L27) ---- +___ ### status @@ -49,12 +49,12 @@ #### Type declaration -| Name | Type | -| :---------- | :-------- | +| Name | Type | +| :------ | :------ | | `contracts` | `boolean` | -| `network` | `boolean` | -| `ok` | `boolean` | +| `network` | `boolean` | +| `ok` | `boolean` | #### Defined in -[src/nevermined/Versions.ts:30](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/Versions.ts#L30) +[src/nevermined/Versions.ts:30](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/Versions.ts#L30) diff --git a/docs/nevermined-sdk/api-reference/interfaces/Profile.md b/docs/nevermined-sdk/api-reference/interfaces/Profile.md index 23d486784e..a706a49be6 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/Profile.md +++ b/docs/nevermined-sdk/api-reference/interfaces/Profile.md @@ -35,9 +35,9 @@ #### Defined in -[src/types/MetadataTypes.ts:118](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L118) +[src/types/MetadataTypes.ts:118](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L118) ---- +___ ### addresses @@ -49,9 +49,9 @@ #### Defined in -[src/types/MetadataTypes.ts:114](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L114) +[src/types/MetadataTypes.ts:114](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L114) ---- +___ ### creationDate @@ -59,9 +59,9 @@ #### Defined in -[src/types/MetadataTypes.ts:123](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L123) +[src/types/MetadataTypes.ts:123](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L123) ---- +___ ### email @@ -73,9 +73,9 @@ #### Defined in -[src/types/MetadataTypes.ts:117](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L117) +[src/types/MetadataTypes.ts:117](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L117) ---- +___ ### isListed @@ -87,9 +87,9 @@ #### Defined in -[src/types/MetadataTypes.ts:112](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L112) +[src/types/MetadataTypes.ts:112](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L112) ---- +___ ### name @@ -101,9 +101,9 @@ #### Defined in -[src/types/MetadataTypes.ts:116](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L116) +[src/types/MetadataTypes.ts:116](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L116) ---- +___ ### nickname @@ -115,9 +115,9 @@ #### Defined in -[src/types/MetadataTypes.ts:115](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L115) +[src/types/MetadataTypes.ts:115](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L115) ---- +___ ### state @@ -129,9 +129,9 @@ #### Defined in -[src/types/MetadataTypes.ts:113](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L113) +[src/types/MetadataTypes.ts:113](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L113) ---- +___ ### updateDate @@ -139,9 +139,9 @@ #### Defined in -[src/types/MetadataTypes.ts:124](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L124) +[src/types/MetadataTypes.ts:124](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L124) ---- +___ ### userId @@ -149,4 +149,4 @@ #### Defined in -[src/types/MetadataTypes.ts:122](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L122) +[src/types/MetadataTypes.ts:122](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L122) diff --git a/docs/nevermined-sdk/api-reference/interfaces/Proof.md b/docs/nevermined-sdk/api-reference/interfaces/Proof.md index 59b41387e5..b95dfcf66c 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/Proof.md +++ b/docs/nevermined-sdk/api-reference/interfaces/Proof.md @@ -20,9 +20,9 @@ #### Defined in -[src/types/DDOTypes.ts:660](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L660) +[src/types/DDOTypes.ts:660](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L660) ---- +___ ### created @@ -30,9 +30,9 @@ #### Defined in -[src/types/DDOTypes.ts:657](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L657) +[src/types/DDOTypes.ts:657](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L657) ---- +___ ### creator @@ -40,9 +40,9 @@ #### Defined in -[src/types/DDOTypes.ts:658](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L658) +[src/types/DDOTypes.ts:658](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L658) ---- +___ ### signatureValue @@ -50,9 +50,9 @@ #### Defined in -[src/types/DDOTypes.ts:659](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L659) +[src/types/DDOTypes.ts:659](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L659) ---- +___ ### type @@ -60,4 +60,4 @@ #### Defined in -[src/types/DDOTypes.ts:656](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L656) +[src/types/DDOTypes.ts:656](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L656) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ProvenanceAttributeRegisteredEvent.md b/docs/nevermined-sdk/api-reference/interfaces/ProvenanceAttributeRegisteredEvent.md index 4ccca6f3c3..cf8a00a082 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ProvenanceAttributeRegisteredEvent.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ProvenanceAttributeRegisteredEvent.md @@ -25,9 +25,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:42](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L42) +[src/keeper/contracts/Provenance.ts:42](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L42) ---- +___ ### agentId @@ -35,9 +35,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:41](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L41) +[src/keeper/contracts/Provenance.ts:41](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L41) ---- +___ ### agentInvolvedId @@ -45,9 +45,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L44) +[src/keeper/contracts/Provenance.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L44) ---- +___ ### attributes @@ -55,9 +55,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:46](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L46) +[src/keeper/contracts/Provenance.ts:46](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L46) ---- +___ ### blockNumberUpdated @@ -65,9 +65,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:47](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L47) +[src/keeper/contracts/Provenance.ts:47](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L47) ---- +___ ### did @@ -75,9 +75,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:40](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L40) +[src/keeper/contracts/Provenance.ts:40](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L40) ---- +___ ### id @@ -85,9 +85,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:38](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L38) +[src/keeper/contracts/Provenance.ts:38](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L38) ---- +___ ### method @@ -95,9 +95,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:45](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L45) +[src/keeper/contracts/Provenance.ts:45](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L45) ---- +___ ### provId @@ -105,9 +105,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L39) +[src/keeper/contracts/Provenance.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L39) ---- +___ ### relatedDid @@ -115,4 +115,4 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:43](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L43) +[src/keeper/contracts/Provenance.ts:43](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L43) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ProvenanceBaseEvent.md b/docs/nevermined-sdk/api-reference/interfaces/ProvenanceBaseEvent.md index 56dbda1d3f..675bd9eacb 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ProvenanceBaseEvent.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ProvenanceBaseEvent.md @@ -35,9 +35,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:53](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L53) +[src/keeper/contracts/Provenance.ts:53](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L53) ---- +___ ### attributes @@ -45,9 +45,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:55](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L55) +[src/keeper/contracts/Provenance.ts:55](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L55) ---- +___ ### blockNumberUpdated @@ -55,9 +55,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:56](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L56) +[src/keeper/contracts/Provenance.ts:56](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L56) ---- +___ ### event @@ -65,9 +65,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L51) +[src/keeper/contracts/Provenance.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L51) ---- +___ ### method @@ -75,9 +75,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L52) +[src/keeper/contracts/Provenance.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L52) ---- +___ ### provId @@ -85,4 +85,4 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:54](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L54) +[src/keeper/contracts/Provenance.ts:54](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L54) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ProvenanceRegistry.md b/docs/nevermined-sdk/api-reference/interfaces/ProvenanceRegistry.md index 05d86e0684..ea78947b13 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ProvenanceRegistry.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ProvenanceRegistry.md @@ -24,9 +24,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:29](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L29) +[src/keeper/contracts/Provenance.ts:29](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L29) ---- +___ ### agentId @@ -34,9 +34,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:28](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L28) +[src/keeper/contracts/Provenance.ts:28](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L28) ---- +___ ### agentInvolvedId @@ -44,9 +44,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:30](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L30) +[src/keeper/contracts/Provenance.ts:30](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L30) ---- +___ ### blockNumberUpdated @@ -54,9 +54,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:33](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L33) +[src/keeper/contracts/Provenance.ts:33](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L33) ---- +___ ### createdBy @@ -64,9 +64,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:32](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L32) +[src/keeper/contracts/Provenance.ts:32](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L32) ---- +___ ### did @@ -74,9 +74,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L26) +[src/keeper/contracts/Provenance.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L26) ---- +___ ### method @@ -84,9 +84,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:31](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L31) +[src/keeper/contracts/Provenance.ts:31](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L31) ---- +___ ### relatedDid @@ -94,9 +94,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:27](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L27) +[src/keeper/contracts/Provenance.ts:27](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L27) ---- +___ ### signatureDelegate @@ -104,4 +104,4 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:34](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L34) +[src/keeper/contracts/Provenance.ts:34](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L34) diff --git a/docs/nevermined-sdk/api-reference/interfaces/Provider.md b/docs/nevermined-sdk/api-reference/interfaces/Provider.md index 954c9071d7..bc91a9be20 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/Provider.md +++ b/docs/nevermined-sdk/api-reference/interfaces/Provider.md @@ -18,9 +18,9 @@ #### Defined in -[src/types/DDOTypes.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L14) +[src/types/DDOTypes.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L14) ---- +___ ### environment @@ -28,19 +28,19 @@ #### Type declaration -| Name | Type | -| :-------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cluster` | \{ `type`: `string` ; `url`: `string` } | -| `cluster.type` | `string` | -| `cluster.url` | `string` | -| `supportedContainers` | \{ `checksum`: `string` ; `image`: `string` ; `tag`: `string` }[] | -| `supportedServers` | \{ `cpu`: `string` ; `disk`: `string` ; `gpu`: `string` ; `maxExecutionTime`: `number` ; `memory`: `string` ; `price`: `string` ; `serverId`: `string` ; `serverType`: `string` }[] | +| Name | Type | +| :------ | :------ | +| `cluster` | \{ `type`: `string` ; `url`: `string` } | +| `cluster.type` | `string` | +| `cluster.url` | `string` | +| `supportedContainers` | \{ `checksum`: `string` ; `image`: `string` ; `tag`: `string` }[] | +| `supportedServers` | \{ `cpu`: `string` ; `disk`: `string` ; `gpu`: `string` ; `maxExecutionTime`: `number` ; `memory`: `string` ; `price`: `string` ; `serverId`: `string` ; `serverType`: `string` }[] | #### Defined in -[src/types/DDOTypes.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L15) +[src/types/DDOTypes.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L15) ---- +___ ### type @@ -48,4 +48,4 @@ #### Defined in -[src/types/DDOTypes.ts:13](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L13) +[src/types/DDOTypes.ts:13](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L13) diff --git a/docs/nevermined-sdk/api-reference/interfaces/PublicKey.md b/docs/nevermined-sdk/api-reference/interfaces/PublicKey.md index af8273aefd..49dd588ca4 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/PublicKey.md +++ b/docs/nevermined-sdk/api-reference/interfaces/PublicKey.md @@ -26,14 +26,14 @@ ID of the key. **`Example`** ```ts -'did:nv:123456789abcdefghi#keys-1' +"did:nv:123456789abcdefghi#keys-1" ``` #### Defined in -[src/types/DDOTypes.ts:498](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L498) +[src/types/DDOTypes.ts:498](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L498) ---- +___ ### owner @@ -44,14 +44,14 @@ Key owner. **`Example`** ```ts -'did:nv:123456789abcdefghi' +"did:nv:123456789abcdefghi" ``` #### Defined in -[src/types/DDOTypes.ts:513](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L513) +[src/types/DDOTypes.ts:513](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L513) ---- +___ ### publicKeyBase58 @@ -59,9 +59,9 @@ Key owner. #### Defined in -[src/types/DDOTypes.ts:516](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L516) +[src/types/DDOTypes.ts:516](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L516) ---- +___ ### publicKeyHex @@ -69,9 +69,9 @@ Key owner. #### Defined in -[src/types/DDOTypes.ts:517](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L517) +[src/types/DDOTypes.ts:517](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L517) ---- +___ ### publicKeyPem @@ -79,16 +79,16 @@ Key owner. #### Defined in -[src/types/DDOTypes.ts:515](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L515) +[src/types/DDOTypes.ts:515](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L515) ---- +___ ### type -• **type**: `"EthereumECDSAKey"` \| `"Ed25519VerificationKey2018"` \| `"RsaVerificationKey2018"` \| `"EdDsaSAPublicKeySecp256k1"` +• **type**: ``"EthereumECDSAKey"`` \| ``"Ed25519VerificationKey2018"`` \| ``"RsaVerificationKey2018"`` \| ``"EdDsaSAPublicKeySecp256k1"`` Type of key. #### Defined in -[src/types/DDOTypes.ts:503](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L503) +[src/types/DDOTypes.ts:503](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L503) diff --git a/docs/nevermined-sdk/api-reference/interfaces/QueryResult.md b/docs/nevermined-sdk/api-reference/interfaces/QueryResult.md index 550241dfeb..cfadf3ecc9 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/QueryResult.md +++ b/docs/nevermined-sdk/api-reference/interfaces/QueryResult.md @@ -19,9 +19,9 @@ #### Defined in -[src/services/metadata/MetadataService.ts:13](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L13) +[src/services/metadata/MetadataService.ts:13](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L13) ---- +___ ### results @@ -29,9 +29,9 @@ #### Defined in -[src/services/metadata/MetadataService.ts:12](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L12) +[src/services/metadata/MetadataService.ts:12](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L12) ---- +___ ### totalPages @@ -39,9 +39,9 @@ #### Defined in -[src/services/metadata/MetadataService.ts:14](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L14) +[src/services/metadata/MetadataService.ts:14](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L14) ---- +___ ### totalResults @@ -53,4 +53,4 @@ #### Defined in -[src/services/metadata/MetadataService.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/metadata/MetadataService.ts#L15) +[src/services/metadata/MetadataService.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/metadata/MetadataService.ts#L15) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ReducedProfile.md b/docs/nevermined-sdk/api-reference/interfaces/ReducedProfile.md index 4306068ec0..11a451df01 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ReducedProfile.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ReducedProfile.md @@ -18,9 +18,9 @@ #### Defined in -[src/types/MetadataTypes.ts:130](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L130) +[src/types/MetadataTypes.ts:130](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L130) ---- +___ ### nickname @@ -28,9 +28,9 @@ #### Defined in -[src/types/MetadataTypes.ts:129](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L129) +[src/types/MetadataTypes.ts:129](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L129) ---- +___ ### userId @@ -38,4 +38,4 @@ #### Defined in -[src/types/MetadataTypes.ts:128](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L128) +[src/types/MetadataTypes.ts:128](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L128) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ResourceAuthentication.md b/docs/nevermined-sdk/api-reference/interfaces/ResourceAuthentication.md index acaf2115d2..11b0b30d1e 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ResourceAuthentication.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ResourceAuthentication.md @@ -20,19 +20,19 @@ #### Defined in -[src/types/DDOTypes.ts:235](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L235) +[src/types/DDOTypes.ts:235](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L235) ---- +___ ### privateParameters -• `Optional` **privateParameters**: \{ `[name: string]`: `string`; }[] +• `Optional` **privateParameters**: \{ `[name: string]`: `string`; }[] #### Defined in -[src/types/DDOTypes.ts:237](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L237) +[src/types/DDOTypes.ts:237](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L237) ---- +___ ### token @@ -40,19 +40,19 @@ #### Defined in -[src/types/DDOTypes.ts:236](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L236) +[src/types/DDOTypes.ts:236](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L236) ---- +___ ### type -• **type**: `"none"` \| `"basic"` \| `"bearer"` \| `"oauth"` +• **type**: ``"none"`` \| ``"basic"`` \| ``"bearer"`` \| ``"oauth"`` #### Defined in -[src/types/DDOTypes.ts:232](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L232) +[src/types/DDOTypes.ts:232](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L232) ---- +___ ### user @@ -60,4 +60,4 @@ #### Defined in -[src/types/DDOTypes.ts:234](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L234) +[src/types/DDOTypes.ts:234](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L234) diff --git a/docs/nevermined-sdk/api-reference/interfaces/RoyaltyAttributes.md b/docs/nevermined-sdk/api-reference/interfaces/RoyaltyAttributes.md index 6923094425..ddc89b3fdf 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/RoyaltyAttributes.md +++ b/docs/nevermined-sdk/api-reference/interfaces/RoyaltyAttributes.md @@ -20,9 +20,9 @@ Attributes defining the royalties model attached to the asset #### Defined in -[src/nevermined/api/AssetsApi.ts:38](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L38) +[src/nevermined/api/AssetsApi.ts:38](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L38) ---- +___ ### royaltyKind @@ -30,9 +30,9 @@ Attributes defining the royalties model attached to the asset #### Defined in -[src/nevermined/api/AssetsApi.ts:36](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L36) +[src/nevermined/api/AssetsApi.ts:36](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L36) ---- +___ ### scheme @@ -40,4 +40,4 @@ Attributes defining the royalties model attached to the asset #### Defined in -[src/nevermined/api/AssetsApi.ts:37](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/api/AssetsApi.ts#L37) +[src/nevermined/api/AssetsApi.ts:37](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/api/AssetsApi.ts#L37) diff --git a/docs/nevermined-sdk/api-reference/interfaces/SearchQuery.md b/docs/nevermined-sdk/api-reference/interfaces/SearchQuery.md index a149de435b..4e7f68c954 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/SearchQuery.md +++ b/docs/nevermined-sdk/api-reference/interfaces/SearchQuery.md @@ -10,7 +10,7 @@ - [offset](SearchQuery.md#offset) - [page](SearchQuery.md#page) - [query](SearchQuery.md#query) -- [show_unlisted](SearchQuery.md#show_unlisted) +- [show\_unlisted](SearchQuery.md#show_unlisted) - [sort](SearchQuery.md#sort) - [text](SearchQuery.md#text) @@ -22,9 +22,9 @@ #### Defined in -[src/types/MetadataTypes.ts:72](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L72) +[src/types/MetadataTypes.ts:72](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L72) ---- +___ ### offset @@ -32,9 +32,9 @@ #### Defined in -[src/types/MetadataTypes.ts:66](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L66) +[src/types/MetadataTypes.ts:66](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L66) ---- +___ ### page @@ -42,9 +42,9 @@ #### Defined in -[src/types/MetadataTypes.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L67) +[src/types/MetadataTypes.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L67) ---- +___ ### query @@ -52,19 +52,19 @@ #### Defined in -[src/types/MetadataTypes.ts:69](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L69) +[src/types/MetadataTypes.ts:69](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L69) ---- +___ -### show_unlisted +### show\_unlisted -• `Optional` **show_unlisted**: `boolean` +• `Optional` **show\_unlisted**: `boolean` #### Defined in -[src/types/MetadataTypes.ts:71](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L71) +[src/types/MetadataTypes.ts:71](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L71) ---- +___ ### sort @@ -72,9 +72,9 @@ #### Defined in -[src/types/MetadataTypes.ts:70](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L70) +[src/types/MetadataTypes.ts:70](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L70) ---- +___ ### text @@ -82,4 +82,4 @@ #### Defined in -[src/types/MetadataTypes.ts:68](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L68) +[src/types/MetadataTypes.ts:68](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L68) diff --git a/docs/nevermined-sdk/api-reference/interfaces/SearchResults.md b/docs/nevermined-sdk/api-reference/interfaces/SearchResults.md index c17682e0ed..b0ba16bd3c 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/SearchResults.md +++ b/docs/nevermined-sdk/api-reference/interfaces/SearchResults.md @@ -13,13 +13,13 @@ ### relation -• **relation**: `"eq"` \| `"gte"` +• **relation**: ``"eq"`` \| ``"gte"`` #### Defined in -[src/types/MetadataTypes.ts:55](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L55) +[src/types/MetadataTypes.ts:55](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L55) ---- +___ ### value @@ -27,4 +27,4 @@ #### Defined in -[src/types/MetadataTypes.ts:54](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/MetadataTypes.ts#L54) +[src/types/MetadataTypes.ts:54](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/MetadataTypes.ts#L54) diff --git a/docs/nevermined-sdk/api-reference/interfaces/Service.md b/docs/nevermined-sdk/api-reference/interfaces/Service.md deleted file mode 100644 index f4270da2b0..0000000000 --- a/docs/nevermined-sdk/api-reference/interfaces/Service.md +++ /dev/null @@ -1,41 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / Service - -# Interface: Service - -## Table of contents - -### Properties - -- [definition](Service.md#definition) -- [spec](Service.md#spec) -- [specChecksum](Service.md#specchecksum) - -## Properties - -### definition - -• **definition**: [`ServiceDefinition`](ServiceDefinition.md) - -#### Defined in - -[src/ddo/MetaData.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L69) - -___ - -### spec - -• `Optional` **spec**: `string` - -#### Defined in - -[src/ddo/MetaData.ts:67](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L67) - -___ - -### specChecksum - -• `Optional` **specChecksum**: `string` - -#### Defined in - -[src/ddo/MetaData.ts:68](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L68) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ServiceAccess.md b/docs/nevermined-sdk/api-reference/interfaces/ServiceAccess.md index b2fdd80a3c..10af0f4fe2 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ServiceAccess.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ServiceAccess.md @@ -28,18 +28,18 @@ #### Type declaration -| Name | Type | -| :----------------------------------------------- | :---------------------------------------------------------------------------------------------------------------- | -| `additionalInformation` | \{ `description`: `string` ; `priceHighestDenomination`: `number` } | -| `additionalInformation.description` | `string` | -| `additionalInformation.priceHighestDenomination` | `number` | -| `main` | \{ `creator`: `string` ; `datePublished`: `string` ; `name`: `string` ; `price`: `string` ; `timeout`: `number` } | -| `main.creator` | `string` | -| `main.datePublished` | `string` | -| `main.name` | `string` | -| `main.price` | `string` | -| `main.timeout` | `number` | -| `serviceAgreementTemplate?` | [`ServiceAgreementTemplate`](ServiceAgreementTemplate.md) | +| Name | Type | +| :------ | :------ | +| `additionalInformation` | \{ `description`: `string` ; `priceHighestDenomination`: `number` } | +| `additionalInformation.description` | `string` | +| `additionalInformation.priceHighestDenomination` | `number` | +| `main` | \{ `creator`: `string` ; `datePublished`: `string` ; `name`: `string` ; `price`: `string` ; `timeout`: `number` } | +| `main.creator` | `string` | +| `main.datePublished` | `string` | +| `main.name` | `string` | +| `main.price` | `string` | +| `main.timeout` | `number` | +| `serviceAgreementTemplate?` | [`ServiceAgreementTemplate`](ServiceAgreementTemplate.md) | #### Overrides @@ -47,9 +47,9 @@ #### Defined in -[src/types/DDOTypes.ts:683](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L683) +[src/types/DDOTypes.ts:683](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L683) ---- +___ ### index @@ -61,9 +61,9 @@ #### Defined in -[src/types/DDOTypes.ts:636](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L636) +[src/types/DDOTypes.ts:636](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L636) ---- +___ ### serviceEndpoint @@ -75,9 +75,9 @@ #### Defined in -[src/types/DDOTypes.ts:637](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L637) +[src/types/DDOTypes.ts:637](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L637) ---- +___ ### templateId @@ -89,13 +89,13 @@ #### Defined in -[src/types/DDOTypes.ts:682](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L682) +[src/types/DDOTypes.ts:682](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L682) ---- +___ ### type -• **type**: `"access"` +• **type**: ``"access"`` #### Overrides @@ -103,4 +103,4 @@ #### Defined in -[src/types/DDOTypes.ts:681](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L681) +[src/types/DDOTypes.ts:681](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L681) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ServiceAgreementTemplate.md b/docs/nevermined-sdk/api-reference/interfaces/ServiceAgreementTemplate.md index 93d81f8e66..951688a676 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ServiceAgreementTemplate.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ServiceAgreementTemplate.md @@ -24,9 +24,9 @@ #### Defined in -[src/types/DDOTypes.ts:840](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L840) +[src/types/DDOTypes.ts:840](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L840) ---- +___ ### conditions @@ -34,9 +34,9 @@ #### Defined in -[src/types/DDOTypes.ts:841](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L841) +[src/types/DDOTypes.ts:841](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L841) ---- +___ ### contractName @@ -44,9 +44,9 @@ #### Defined in -[src/types/DDOTypes.ts:837](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L837) +[src/types/DDOTypes.ts:837](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L837) ---- +___ ### events @@ -54,9 +54,9 @@ #### Defined in -[src/types/DDOTypes.ts:838](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L838) +[src/types/DDOTypes.ts:838](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L838) ---- +___ ### fulfillmentOrder @@ -64,4 +64,4 @@ #### Defined in -[src/types/DDOTypes.ts:839](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L839) +[src/types/DDOTypes.ts:839](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L839) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ServiceAgreementTemplateCondition.md b/docs/nevermined-sdk/api-reference/interfaces/ServiceAgreementTemplateCondition.md index 55bbe4de12..77117d70c6 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ServiceAgreementTemplateCondition.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ServiceAgreementTemplateCondition.md @@ -22,9 +22,9 @@ #### Defined in -[src/types/DDOTypes.ts:830](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L830) +[src/types/DDOTypes.ts:830](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L830) ---- +___ ### events @@ -32,9 +32,9 @@ #### Defined in -[src/types/DDOTypes.ts:833](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L833) +[src/types/DDOTypes.ts:833](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L833) ---- +___ ### functionName @@ -42,9 +42,9 @@ #### Defined in -[src/types/DDOTypes.ts:831](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L831) +[src/types/DDOTypes.ts:831](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L831) ---- +___ ### name @@ -52,9 +52,9 @@ #### Defined in -[src/types/DDOTypes.ts:827](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L827) +[src/types/DDOTypes.ts:827](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L827) ---- +___ ### parameters @@ -62,9 +62,9 @@ #### Defined in -[src/types/DDOTypes.ts:832](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L832) +[src/types/DDOTypes.ts:832](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L832) ---- +___ ### timelock @@ -72,9 +72,9 @@ #### Defined in -[src/types/DDOTypes.ts:828](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L828) +[src/types/DDOTypes.ts:828](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L828) ---- +___ ### timeout @@ -82,4 +82,4 @@ #### Defined in -[src/types/DDOTypes.ts:829](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L829) +[src/types/DDOTypes.ts:829](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L829) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ServiceAgreementTemplateEvent.md b/docs/nevermined-sdk/api-reference/interfaces/ServiceAgreementTemplateEvent.md index 0dba003c55..35cdbe9cca 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ServiceAgreementTemplateEvent.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ServiceAgreementTemplateEvent.md @@ -18,9 +18,9 @@ #### Defined in -[src/types/DDOTypes.ts:818](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L818) +[src/types/DDOTypes.ts:818](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L818) ---- +___ ### handler @@ -28,17 +28,17 @@ #### Type declaration -| Name | Type | -| :------------- | :------- | +| Name | Type | +| :------ | :------ | | `functionName` | `string` | -| `moduleName` | `string` | -| `version` | `string` | +| `moduleName` | `string` | +| `version` | `string` | #### Defined in -[src/types/DDOTypes.ts:819](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L819) +[src/types/DDOTypes.ts:819](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L819) ---- +___ ### name @@ -46,4 +46,4 @@ #### Defined in -[src/types/DDOTypes.ts:817](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L817) +[src/types/DDOTypes.ts:817](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L817) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ServiceAgreementTemplateParameter.md b/docs/nevermined-sdk/api-reference/interfaces/ServiceAgreementTemplateParameter.md index ec5567bbd7..d3434b8d01 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ServiceAgreementTemplateParameter.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ServiceAgreementTemplateParameter.md @@ -18,9 +18,9 @@ #### Defined in -[src/types/DDOTypes.ts:811](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L811) +[src/types/DDOTypes.ts:811](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L811) ---- +___ ### type @@ -28,9 +28,9 @@ #### Defined in -[src/types/DDOTypes.ts:812](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L812) +[src/types/DDOTypes.ts:812](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L812) ---- +___ ### value @@ -38,4 +38,4 @@ #### Defined in -[src/types/DDOTypes.ts:813](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L813) +[src/types/DDOTypes.ts:813](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L813) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ServiceAttributes.md b/docs/nevermined-sdk/api-reference/interfaces/ServiceAttributes.md index 6c6dec6514..6cd1f89934 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ServiceAttributes.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ServiceAttributes.md @@ -19,9 +19,9 @@ #### Defined in -[src/types/DDOTypes.ts:667](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L667) +[src/types/DDOTypes.ts:667](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L667) ---- +___ ### price @@ -29,9 +29,9 @@ #### Defined in -[src/types/DDOTypes.ts:666](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L666) +[src/types/DDOTypes.ts:666](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L666) ---- +___ ### serviceIndex @@ -39,9 +39,9 @@ #### Defined in -[src/types/DDOTypes.ts:665](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L665) +[src/types/DDOTypes.ts:665](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L665) ---- +___ ### serviceType @@ -49,4 +49,4 @@ #### Defined in -[src/types/DDOTypes.ts:664](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L664) +[src/types/DDOTypes.ts:664](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L664) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ServiceAuthorization.md b/docs/nevermined-sdk/api-reference/interfaces/ServiceAuthorization.md index 216eaf3999..6e89769e1a 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ServiceAuthorization.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ServiceAuthorization.md @@ -31,9 +31,9 @@ #### Defined in -[src/types/DDOTypes.ts:639](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L639) +[src/types/DDOTypes.ts:639](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L639) ---- +___ ### index @@ -45,19 +45,19 @@ #### Defined in -[src/types/DDOTypes.ts:636](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L636) +[src/types/DDOTypes.ts:636](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L636) ---- +___ ### service -• **service**: `"None"` \| `"RSAES-OAEP"` +• **service**: ``"None"`` \| ``"RSAES-OAEP"`` #### Defined in -[src/types/DDOTypes.ts:672](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L672) +[src/types/DDOTypes.ts:672](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L672) ---- +___ ### serviceEndpoint @@ -69,9 +69,9 @@ #### Defined in -[src/types/DDOTypes.ts:637](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L637) +[src/types/DDOTypes.ts:637](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L637) ---- +___ ### templateId @@ -83,13 +83,13 @@ #### Defined in -[src/types/DDOTypes.ts:638](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L638) +[src/types/DDOTypes.ts:638](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L638) ---- +___ ### type -• **type**: `"authorization"` +• **type**: ``"authorization"`` #### Overrides @@ -97,4 +97,4 @@ #### Defined in -[src/types/DDOTypes.ts:671](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L671) +[src/types/DDOTypes.ts:671](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L671) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ServiceCommon.md b/docs/nevermined-sdk/api-reference/interfaces/ServiceCommon.md index 665b68b2bd..31a361a58d 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ServiceCommon.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ServiceCommon.md @@ -36,9 +36,9 @@ #### Defined in -[src/types/DDOTypes.ts:639](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L639) +[src/types/DDOTypes.ts:639](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L639) ---- +___ ### index @@ -46,9 +46,9 @@ #### Defined in -[src/types/DDOTypes.ts:636](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L636) +[src/types/DDOTypes.ts:636](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L636) ---- +___ ### serviceEndpoint @@ -56,9 +56,9 @@ #### Defined in -[src/types/DDOTypes.ts:637](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L637) +[src/types/DDOTypes.ts:637](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L637) ---- +___ ### templateId @@ -66,9 +66,9 @@ #### Defined in -[src/types/DDOTypes.ts:638](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L638) +[src/types/DDOTypes.ts:638](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L638) ---- +___ ### type @@ -76,4 +76,4 @@ #### Defined in -[src/types/DDOTypes.ts:635](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L635) +[src/types/DDOTypes.ts:635](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L635) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ServiceCompute.md b/docs/nevermined-sdk/api-reference/interfaces/ServiceCompute.md index 2a6ee103f6..fab4412ffb 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ServiceCompute.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ServiceCompute.md @@ -28,18 +28,18 @@ #### Type declaration -| Name | Type | -| :----------------------------------------------- | :---------------------------------------------------------------------------------------------------------------- | -| `additionalInformation` | \{ `description`: `string` ; `priceHighestDenomination`: `number` } | -| `additionalInformation.description` | `string` | -| `additionalInformation.priceHighestDenomination` | `number` | -| `main` | \{ `creator`: `string` ; `datePublished`: `string` ; `name`: `string` ; `price`: `string` ; `timeout`: `number` } | -| `main.creator` | `string` | -| `main.datePublished` | `string` | -| `main.name` | `string` | -| `main.price` | `string` | -| `main.timeout` | `number` | -| `serviceAgreementTemplate?` | [`ServiceAgreementTemplate`](ServiceAgreementTemplate.md) | +| Name | Type | +| :------ | :------ | +| `additionalInformation` | \{ `description`: `string` ; `priceHighestDenomination`: `number` } | +| `additionalInformation.description` | `string` | +| `additionalInformation.priceHighestDenomination` | `number` | +| `main` | \{ `creator`: `string` ; `datePublished`: `string` ; `name`: `string` ; `price`: `string` ; `timeout`: `number` } | +| `main.creator` | `string` | +| `main.datePublished` | `string` | +| `main.name` | `string` | +| `main.price` | `string` | +| `main.timeout` | `number` | +| `serviceAgreementTemplate?` | [`ServiceAgreementTemplate`](ServiceAgreementTemplate.md) | #### Overrides @@ -47,9 +47,9 @@ #### Defined in -[src/types/DDOTypes.ts:702](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L702) +[src/types/DDOTypes.ts:702](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L702) ---- +___ ### index @@ -61,9 +61,9 @@ #### Defined in -[src/types/DDOTypes.ts:636](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L636) +[src/types/DDOTypes.ts:636](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L636) ---- +___ ### serviceEndpoint @@ -75,9 +75,9 @@ #### Defined in -[src/types/DDOTypes.ts:637](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L637) +[src/types/DDOTypes.ts:637](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L637) ---- +___ ### templateId @@ -89,13 +89,13 @@ #### Defined in -[src/types/DDOTypes.ts:701](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L701) +[src/types/DDOTypes.ts:701](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L701) ---- +___ ### type -• **type**: `"compute"` +• **type**: ``"compute"`` #### Overrides @@ -103,4 +103,4 @@ #### Defined in -[src/types/DDOTypes.ts:700](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L700) +[src/types/DDOTypes.ts:700](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L700) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ServiceDefinition.md b/docs/nevermined-sdk/api-reference/interfaces/ServiceDefinition.md index 2b348e8f89..6e0bbb80a3 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ServiceDefinition.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ServiceDefinition.md @@ -17,18 +17,18 @@ #### Type declaration -| Name | Type | -| :---------- | :------- | +| Name | Type | +| :------ | :------ | | `password?` | `string` | -| `token?` | `string` | -| `type` | `string` | -| `user?` | `string` | +| `token?` | `string` | +| `type` | `string` | +| `user?` | `string` | #### Defined in -[src/types/DDOTypes.ts:94](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L94) +[src/types/DDOTypes.ts:94](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L94) ---- +___ ### endpoints @@ -36,13 +36,13 @@ #### Type declaration -| Name | Type | -| :------------- | :--------- | +| Name | Type | +| :------ | :------ | | `contentTypes` | `string`[] | -| `index` | `number` | -| `method` | `string` | -| `url` | `string` | +| `index` | `number` | +| `method` | `string` | +| `url` | `string` | #### Defined in -[src/types/DDOTypes.ts:100](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L100) +[src/types/DDOTypes.ts:100](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L100) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ServiceMetadata.md b/docs/nevermined-sdk/api-reference/interfaces/ServiceMetadata.md index d65307a12f..3c46d36ae5 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ServiceMetadata.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ServiceMetadata.md @@ -33,9 +33,9 @@ #### Defined in -[src/types/DDOTypes.ts:677](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L677) +[src/types/DDOTypes.ts:677](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L677) ---- +___ ### definition @@ -43,9 +43,9 @@ #### Defined in -[src/types/DDOTypes.ts:111](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L111) +[src/types/DDOTypes.ts:111](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L111) ---- +___ ### index @@ -57,9 +57,9 @@ #### Defined in -[src/types/DDOTypes.ts:636](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L636) +[src/types/DDOTypes.ts:636](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L636) ---- +___ ### serviceEndpoint @@ -71,9 +71,9 @@ #### Defined in -[src/types/DDOTypes.ts:637](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L637) +[src/types/DDOTypes.ts:637](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L637) ---- +___ ### spec @@ -81,9 +81,9 @@ #### Defined in -[src/types/DDOTypes.ts:109](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L109) +[src/types/DDOTypes.ts:109](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L109) ---- +___ ### specChecksum @@ -91,9 +91,9 @@ #### Defined in -[src/types/DDOTypes.ts:110](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L110) +[src/types/DDOTypes.ts:110](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L110) ---- +___ ### templateId @@ -105,13 +105,13 @@ #### Defined in -[src/types/DDOTypes.ts:638](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L638) +[src/types/DDOTypes.ts:638](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L638) ---- +___ ### type -• **type**: `"metadata"` +• **type**: ``"metadata"`` #### Inherited from @@ -119,4 +119,4 @@ #### Defined in -[src/types/DDOTypes.ts:676](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L676) +[src/types/DDOTypes.ts:676](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L676) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ServiceNFTAccess.md b/docs/nevermined-sdk/api-reference/interfaces/ServiceNFTAccess.md index 93eef0ea4e..69da0e6a79 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ServiceNFTAccess.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ServiceNFTAccess.md @@ -26,19 +26,19 @@ #### Type declaration -| Name | Type | -| :---------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `additionalInformation` | \{ `description`: `string` } | -| `additionalInformation.description` | `string` | -| `main` | \{ `creator`: `string` ; `datePublished`: `string` ; `ercType`: [`ERCType`](../enums/ERCType.md) ; `name`: `string` ; `nftAttributes?`: [`NFTServiceAttributes`](../classes/NFTServiceAttributes.md) ; `nftType`: [`NeverminedNFTType`](../code-reference.md#neverminednfttype) ; `timeout`: `number` } | -| `main.creator` | `string` | -| `main.datePublished` | `string` | -| `main.ercType` | [`ERCType`](../enums/ERCType.md) | -| `main.name` | `string` | -| `main.nftAttributes?` | [`NFTServiceAttributes`](../classes/NFTServiceAttributes.md) | -| `main.nftType` | [`NeverminedNFTType`](../code-reference.md#neverminednfttype) | -| `main.timeout` | `number` | -| `serviceAgreementTemplate?` | [`ServiceAgreementTemplate`](ServiceAgreementTemplate.md) | +| Name | Type | +| :------ | :------ | +| `additionalInformation` | \{ `description`: `string` } | +| `additionalInformation.description` | `string` | +| `main` | \{ `creator`: `string` ; `datePublished`: `string` ; `ercType`: [`ERCType`](../enums/ERCType.md) ; `name`: `string` ; `nftAttributes?`: [`NFTServiceAttributes`](../classes/NFTServiceAttributes.md) ; `nftType`: [`NeverminedNFTType`](../code-reference.md#neverminednfttype) ; `timeout`: `number` } | +| `main.creator` | `string` | +| `main.datePublished` | `string` | +| `main.ercType` | [`ERCType`](../enums/ERCType.md) | +| `main.name` | `string` | +| `main.nftAttributes?` | [`NFTServiceAttributes`](../classes/NFTServiceAttributes.md) | +| `main.nftType` | [`NeverminedNFTType`](../code-reference.md#neverminednfttype) | +| `main.timeout` | `number` | +| `serviceAgreementTemplate?` | [`ServiceAgreementTemplate`](ServiceAgreementTemplate.md) | #### Overrides @@ -46,9 +46,9 @@ #### Defined in -[src/types/DDOTypes.ts:721](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L721) +[src/types/DDOTypes.ts:721](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L721) ---- +___ ### index @@ -60,9 +60,9 @@ #### Defined in -[src/types/DDOTypes.ts:636](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L636) +[src/types/DDOTypes.ts:636](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L636) ---- +___ ### serviceEndpoint @@ -74,9 +74,9 @@ #### Defined in -[src/types/DDOTypes.ts:637](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L637) +[src/types/DDOTypes.ts:637](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L637) ---- +___ ### templateId @@ -88,13 +88,13 @@ #### Defined in -[src/types/DDOTypes.ts:720](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L720) +[src/types/DDOTypes.ts:720](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L720) ---- +___ ### type -• **type**: `"nft-access"` +• **type**: ``"nft-access"`` #### Overrides @@ -102,4 +102,4 @@ #### Defined in -[src/types/DDOTypes.ts:719](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L719) +[src/types/DDOTypes.ts:719](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L719) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ServiceNFTSales.md b/docs/nevermined-sdk/api-reference/interfaces/ServiceNFTSales.md index f648f3ebfa..c44cfdf94f 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ServiceNFTSales.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ServiceNFTSales.md @@ -28,21 +28,21 @@ #### Type declaration -| Name | Type | -| :----------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `additionalInformation` | \{ `description`: `string` ; `priceHighestDenomination`: `number` } | -| `additionalInformation.description` | `string` | -| `additionalInformation.priceHighestDenomination` | `number` | -| `main` | \{ `creator`: `string` ; `datePublished`: `string` ; `ercType`: [`ERCType`](../enums/ERCType.md) ; `name`: `string` ; `nftAttributes?`: [`NFTServiceAttributes`](../classes/NFTServiceAttributes.md) ; `nftType`: [`NeverminedNFTType`](../code-reference.md#neverminednfttype) ; `price`: `string` ; `timeout`: `number` } | -| `main.creator` | `string` | -| `main.datePublished` | `string` | -| `main.ercType` | [`ERCType`](../enums/ERCType.md) | -| `main.name` | `string` | -| `main.nftAttributes?` | [`NFTServiceAttributes`](../classes/NFTServiceAttributes.md) | -| `main.nftType` | [`NeverminedNFTType`](../code-reference.md#neverminednfttype) | -| `main.price` | `string` | -| `main.timeout` | `number` | -| `serviceAgreementTemplate?` | [`ServiceAgreementTemplate`](ServiceAgreementTemplate.md) | +| Name | Type | +| :------ | :------ | +| `additionalInformation` | \{ `description`: `string` ; `priceHighestDenomination`: `number` } | +| `additionalInformation.description` | `string` | +| `additionalInformation.priceHighestDenomination` | `number` | +| `main` | \{ `creator`: `string` ; `datePublished`: `string` ; `ercType`: [`ERCType`](../enums/ERCType.md) ; `name`: `string` ; `nftAttributes?`: [`NFTServiceAttributes`](../classes/NFTServiceAttributes.md) ; `nftType`: [`NeverminedNFTType`](../code-reference.md#neverminednfttype) ; `price`: `string` ; `timeout`: `number` } | +| `main.creator` | `string` | +| `main.datePublished` | `string` | +| `main.ercType` | [`ERCType`](../enums/ERCType.md) | +| `main.name` | `string` | +| `main.nftAttributes?` | [`NFTServiceAttributes`](../classes/NFTServiceAttributes.md) | +| `main.nftType` | [`NeverminedNFTType`](../code-reference.md#neverminednfttype) | +| `main.price` | `string` | +| `main.timeout` | `number` | +| `serviceAgreementTemplate?` | [`ServiceAgreementTemplate`](ServiceAgreementTemplate.md) | #### Overrides @@ -50,9 +50,9 @@ #### Defined in -[src/types/DDOTypes.ts:741](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L741) +[src/types/DDOTypes.ts:741](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L741) ---- +___ ### index @@ -64,9 +64,9 @@ #### Defined in -[src/types/DDOTypes.ts:636](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L636) +[src/types/DDOTypes.ts:636](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L636) ---- +___ ### serviceEndpoint @@ -78,9 +78,9 @@ #### Defined in -[src/types/DDOTypes.ts:637](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L637) +[src/types/DDOTypes.ts:637](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L637) ---- +___ ### templateId @@ -92,13 +92,13 @@ #### Defined in -[src/types/DDOTypes.ts:740](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L740) +[src/types/DDOTypes.ts:740](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L740) ---- +___ ### type -• **type**: `"nft-sales"` +• **type**: ``"nft-sales"`` #### Overrides @@ -106,4 +106,4 @@ #### Defined in -[src/types/DDOTypes.ts:739](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L739) +[src/types/DDOTypes.ts:739](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L739) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ServicePlugin.md b/docs/nevermined-sdk/api-reference/interfaces/ServicePlugin.md index b22ef88ccd..67341364a0 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ServicePlugin.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ServicePlugin.md @@ -4,9 +4,9 @@ ## Type parameters -| Name | Type | -| :--- | :------------------------------------------------ | -| `T` | extends [`Service`](../code-reference.md#service) | +| Name | Type | +| :------ | :------ | +| `T` | extends [`Service`](../code-reference.md#service) | ## Implemented by @@ -32,8 +32,8 @@ #### Parameters -| Name | Type | -| :------- | :---------------------------------------- | +| Name | Type | +| :------ | :------ | | `params` | [`ValidationParams`](ValidationParams.md) | #### Returns @@ -42,9 +42,9 @@ #### Defined in -[src/types/DDOTypes.ts:805](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L805) +[src/types/DDOTypes.ts:805](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L805) ---- +___ ### createService @@ -52,13 +52,13 @@ #### Parameters -| Name | Type | -| :------------------ | :---------------------------------------------------------------------------- | -| `publisher` | [`NvmAccount`](../classes/NvmAccount.md) | -| `metadata` | [`MetaData`](MetaData.md) | -| `serviceAttributes` | [`ServiceAttributes`](ServiceAttributes.md) | -| `nftAttributes?` | [`NFTAttributes`](../classes/NFTAttributes.md) | -| `pricedData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | +| Name | Type | +| :------ | :------ | +| `publisher` | [`NvmAccount`](../classes/NvmAccount.md) | +| `metadata` | [`MetaData`](MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](../classes/NFTAttributes.md) | +| `pricedData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | #### Returns @@ -66,9 +66,9 @@ #### Defined in -[src/types/DDOTypes.ts:795](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L795) +[src/types/DDOTypes.ts:795](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L795) ---- +___ ### process @@ -76,11 +76,11 @@ #### Parameters -| Name | Type | -| :---------- | :---------------------------------------- | -| `params` | [`ValidationParams`](ValidationParams.md) | -| `from` | [`NvmAccount`](../classes/NvmAccount.md) | -| `txparams?` | [`TxParameters`](TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `params` | [`ValidationParams`](ValidationParams.md) | +| `from` | [`NvmAccount`](../classes/NvmAccount.md) | +| `txparams?` | [`TxParameters`](TxParameters.md) | #### Returns @@ -88,9 +88,9 @@ #### Defined in -[src/types/DDOTypes.ts:803](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L803) +[src/types/DDOTypes.ts:803](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L803) ---- +___ ### track @@ -98,11 +98,11 @@ #### Parameters -| Name | Type | -| :---------- | :---------------------------------------- | -| `params` | [`ValidationParams`](ValidationParams.md) | -| `from` | [`NvmAccount`](../classes/NvmAccount.md) | -| `txparams?` | [`TxParameters`](TxParameters.md) | +| Name | Type | +| :------ | :------ | +| `params` | [`ValidationParams`](ValidationParams.md) | +| `from` | [`NvmAccount`](../classes/NvmAccount.md) | +| `txparams?` | [`TxParameters`](TxParameters.md) | #### Returns @@ -110,4 +110,4 @@ #### Defined in -[src/types/DDOTypes.ts:807](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L807) +[src/types/DDOTypes.ts:807](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L807) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ServiceSecondary.md b/docs/nevermined-sdk/api-reference/interfaces/ServiceSecondary.md index 0d8d09136e..b7241b1a95 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ServiceSecondary.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ServiceSecondary.md @@ -28,9 +28,9 @@ #### Defined in -[src/types/DDOTypes.ts:761](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L761) +[src/types/DDOTypes.ts:761](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L761) ---- +___ ### attributes @@ -42,9 +42,9 @@ Service.attributes #### Defined in -[src/types/DDOTypes.ts:639](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L639) +[src/types/DDOTypes.ts:639](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L639) ---- +___ ### did @@ -52,9 +52,9 @@ Service.attributes #### Defined in -[src/types/DDOTypes.ts:762](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L762) +[src/types/DDOTypes.ts:762](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L762) ---- +___ ### index @@ -66,9 +66,9 @@ Service.index #### Defined in -[src/types/DDOTypes.ts:636](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L636) +[src/types/DDOTypes.ts:636](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L636) ---- +___ ### serviceEndpoint @@ -80,9 +80,9 @@ Service.serviceEndpoint #### Defined in -[src/types/DDOTypes.ts:637](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L637) +[src/types/DDOTypes.ts:637](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L637) ---- +___ ### templateId @@ -94,9 +94,9 @@ Service.templateId #### Defined in -[src/types/DDOTypes.ts:638](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L638) +[src/types/DDOTypes.ts:638](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L638) ---- +___ ### type @@ -108,4 +108,4 @@ Service.type #### Defined in -[src/types/DDOTypes.ts:635](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L635) +[src/types/DDOTypes.ts:635](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L635) diff --git a/docs/nevermined-sdk/api-reference/interfaces/Stage.md b/docs/nevermined-sdk/api-reference/interfaces/Stage.md index 9941e7b70c..582f077258 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/Stage.md +++ b/docs/nevermined-sdk/api-reference/interfaces/Stage.md @@ -20,9 +20,9 @@ #### Defined in -[src/types/DDOTypes.ts:54](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L54) +[src/types/DDOTypes.ts:54](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L54) ---- +___ ### input @@ -30,9 +30,9 @@ #### Defined in -[src/types/DDOTypes.ts:56](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L56) +[src/types/DDOTypes.ts:56](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L56) ---- +___ ### output @@ -40,9 +40,9 @@ #### Defined in -[src/types/DDOTypes.ts:58](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L58) +[src/types/DDOTypes.ts:58](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L58) ---- +___ ### stageType @@ -50,9 +50,9 @@ #### Defined in -[src/types/DDOTypes.ts:55](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L55) +[src/types/DDOTypes.ts:55](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L55) ---- +___ ### transformation @@ -60,4 +60,4 @@ #### Defined in -[src/types/DDOTypes.ts:57](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L57) +[src/types/DDOTypes.ts:57](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L57) diff --git a/docs/nevermined-sdk/api-reference/interfaces/StageInput.md b/docs/nevermined-sdk/api-reference/interfaces/StageInput.md index 8608c8f8d1..ecb04218ee 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/StageInput.md +++ b/docs/nevermined-sdk/api-reference/interfaces/StageInput.md @@ -17,9 +17,9 @@ #### Defined in -[src/types/DDOTypes.ts:40](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L40) +[src/types/DDOTypes.ts:40](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L40) ---- +___ ### index @@ -27,4 +27,4 @@ #### Defined in -[src/types/DDOTypes.ts:39](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L39) +[src/types/DDOTypes.ts:39](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L39) diff --git a/docs/nevermined-sdk/api-reference/interfaces/StageOutput.md b/docs/nevermined-sdk/api-reference/interfaces/StageOutput.md index 14831cf7b8..1d005805bd 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/StageOutput.md +++ b/docs/nevermined-sdk/api-reference/interfaces/StageOutput.md @@ -18,9 +18,9 @@ #### Defined in -[src/types/DDOTypes.ts:49](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L49) +[src/types/DDOTypes.ts:49](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L49) ---- +___ ### metadata @@ -28,9 +28,9 @@ #### Defined in -[src/types/DDOTypes.ts:50](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L50) +[src/types/DDOTypes.ts:50](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L50) ---- +___ ### metadataUrl @@ -38,4 +38,4 @@ #### Defined in -[src/types/DDOTypes.ts:48](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L48) +[src/types/DDOTypes.ts:48](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L48) diff --git a/docs/nevermined-sdk/api-reference/interfaces/StageRequirements.md b/docs/nevermined-sdk/api-reference/interfaces/StageRequirements.md deleted file mode 100644 index 6a3d899513..0000000000 --- a/docs/nevermined-sdk/api-reference/interfaces/StageRequirements.md +++ /dev/null @@ -1,27 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / StageRequirements - -# Interface: StageRequirements - -## Table of contents - -### Properties - -- [container](StageRequirements.md#container) - -## Properties - -### container - -• **container**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `checksum` | `string` | -| `image` | `string` | -| `tag` | `string` | - -#### Defined in - -[src/ddo/MetaData.ts:4](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L4) diff --git a/docs/nevermined-sdk/api-reference/interfaces/StageTransformation.md b/docs/nevermined-sdk/api-reference/interfaces/StageTransformation.md index cf0c47757c..2581fa0b3a 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/StageTransformation.md +++ b/docs/nevermined-sdk/api-reference/interfaces/StageTransformation.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/DDOTypes.ts:44](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L44) +[src/types/DDOTypes.ts:44](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L44) diff --git a/docs/nevermined-sdk/api-reference/interfaces/SubscriptionBalance.md b/docs/nevermined-sdk/api-reference/interfaces/SubscriptionBalance.md index 5369d4cf42..cce006d981 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/SubscriptionBalance.md +++ b/docs/nevermined-sdk/api-reference/interfaces/SubscriptionBalance.md @@ -19,9 +19,9 @@ #### Defined in -[src/nevermined/NvmApp.ts:62](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L62) +[src/nevermined/NvmApp.ts:62](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L62) ---- +___ ### canAccess @@ -29,9 +29,9 @@ #### Defined in -[src/nevermined/NvmApp.ts:60](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L60) +[src/nevermined/NvmApp.ts:60](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L60) ---- +___ ### isSubscriptionOwner @@ -39,9 +39,9 @@ #### Defined in -[src/nevermined/NvmApp.ts:61](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L61) +[src/nevermined/NvmApp.ts:61](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L61) ---- +___ ### subscriptionType @@ -49,4 +49,4 @@ #### Defined in -[src/nevermined/NvmApp.ts:59](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/nevermined/NvmApp.ts#L59) +[src/nevermined/NvmApp.ts:59](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/nevermined/NvmApp.ts#L59) diff --git a/docs/nevermined-sdk/api-reference/interfaces/SubscriptionMetadata.md b/docs/nevermined-sdk/api-reference/interfaces/SubscriptionMetadata.md index d0bf2d57a4..bf953c2a07 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/SubscriptionMetadata.md +++ b/docs/nevermined-sdk/api-reference/interfaces/SubscriptionMetadata.md @@ -17,9 +17,9 @@ #### Defined in -[src/types/DDOTypes.ts:221](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L221) +[src/types/DDOTypes.ts:221](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L221) ---- +___ ### timeMeasure @@ -27,4 +27,4 @@ #### Defined in -[src/types/DDOTypes.ts:222](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L222) +[src/types/DDOTypes.ts:222](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L222) diff --git a/docs/nevermined-sdk/api-reference/interfaces/SubscriptionToken.md b/docs/nevermined-sdk/api-reference/interfaces/SubscriptionToken.md index e77ce535d3..00c36b7449 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/SubscriptionToken.md +++ b/docs/nevermined-sdk/api-reference/interfaces/SubscriptionToken.md @@ -17,9 +17,9 @@ #### Defined in -[src/services/node/NeverminedNode.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L26) +[src/services/node/NeverminedNode.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L26) ---- +___ ### neverminedProxyUri @@ -27,4 +27,4 @@ #### Defined in -[src/services/node/NeverminedNode.ts:27](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/services/node/NeverminedNode.ts#L27) +[src/services/node/NeverminedNode.ts:27](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/services/node/NeverminedNode.ts#L27) diff --git a/docs/nevermined-sdk/api-reference/interfaces/TemplateMetadata.md b/docs/nevermined-sdk/api-reference/interfaces/TemplateMetadata.md index d290b00168..e73601ad59 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/TemplateMetadata.md +++ b/docs/nevermined-sdk/api-reference/interfaces/TemplateMetadata.md @@ -19,9 +19,9 @@ #### Defined in -[src/keeper/contracts/managers/TemplateStoreManager.ts:18](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/TemplateStoreManager.ts#L18) +[src/keeper/contracts/managers/TemplateStoreManager.ts:18](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/TemplateStoreManager.ts#L18) ---- +___ ### lastUpdatedBy @@ -29,9 +29,9 @@ #### Defined in -[src/keeper/contracts/managers/TemplateStoreManager.ts:17](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/TemplateStoreManager.ts#L17) +[src/keeper/contracts/managers/TemplateStoreManager.ts:17](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/TemplateStoreManager.ts#L17) ---- +___ ### owner @@ -39,9 +39,9 @@ #### Defined in -[src/keeper/contracts/managers/TemplateStoreManager.ts:16](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/TemplateStoreManager.ts#L16) +[src/keeper/contracts/managers/TemplateStoreManager.ts:16](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/TemplateStoreManager.ts#L16) ---- +___ ### state @@ -49,4 +49,4 @@ #### Defined in -[src/keeper/contracts/managers/TemplateStoreManager.ts:15](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/managers/TemplateStoreManager.ts#L15) +[src/keeper/contracts/managers/TemplateStoreManager.ts:15](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/managers/TemplateStoreManager.ts#L15) diff --git a/docs/nevermined-sdk/api-reference/interfaces/TxParameters.md b/docs/nevermined-sdk/api-reference/interfaces/TxParameters.md index 8fe2344d93..16e4fe4c87 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/TxParameters.md +++ b/docs/nevermined-sdk/api-reference/interfaces/TxParameters.md @@ -23,9 +23,9 @@ #### Defined in -[src/models/Transactions.ts:3](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/Transactions.ts#L3) +[src/models/Transactions.ts:3](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/Transactions.ts#L3) ---- +___ ### gasMultiplier @@ -33,9 +33,9 @@ #### Defined in -[src/models/Transactions.ts:4](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/Transactions.ts#L4) +[src/models/Transactions.ts:4](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/Transactions.ts#L4) ---- +___ ### gasPrice @@ -43,9 +43,9 @@ #### Defined in -[src/models/Transactions.ts:5](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/Transactions.ts#L5) +[src/models/Transactions.ts:5](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/Transactions.ts#L5) ---- +___ ### maxFeePerGas @@ -53,9 +53,9 @@ #### Defined in -[src/models/Transactions.ts:7](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/Transactions.ts#L7) +[src/models/Transactions.ts:7](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/Transactions.ts#L7) ---- +___ ### maxPriorityFeePerGas @@ -63,9 +63,9 @@ #### Defined in -[src/models/Transactions.ts:6](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/Transactions.ts#L6) +[src/models/Transactions.ts:6](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/Transactions.ts#L6) ---- +___ ### nonce @@ -73,9 +73,9 @@ #### Defined in -[src/models/Transactions.ts:8](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/Transactions.ts#L8) +[src/models/Transactions.ts:8](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/Transactions.ts#L8) ---- +___ ### progress @@ -87,8 +87,8 @@ ##### Parameters -| Name | Type | -| :----- | :---- | +| Name | Type | +| :------ | :------ | | `data` | `any` | ##### Returns @@ -97,9 +97,9 @@ #### Defined in -[src/models/Transactions.ts:9](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/Transactions.ts#L9) +[src/models/Transactions.ts:9](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/Transactions.ts#L9) ---- +___ ### value @@ -107,4 +107,4 @@ #### Defined in -[src/models/Transactions.ts:2](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/models/Transactions.ts#L2) +[src/models/Transactions.ts:2](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/models/Transactions.ts#L2) diff --git a/docs/nevermined-sdk/api-reference/interfaces/TypedDataDomain.md b/docs/nevermined-sdk/api-reference/interfaces/TypedDataDomain.md index 6af2bb5a32..8458c4dc15 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/TypedDataDomain.md +++ b/docs/nevermined-sdk/api-reference/interfaces/TypedDataDomain.md @@ -18,9 +18,9 @@ #### Defined in -[src/types/GeneralTypes.ts:83](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L83) +[src/types/GeneralTypes.ts:83](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L83) ---- +___ ### name @@ -28,9 +28,9 @@ #### Defined in -[src/types/GeneralTypes.ts:81](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L81) +[src/types/GeneralTypes.ts:81](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L81) ---- +___ ### version @@ -38,4 +38,4 @@ #### Defined in -[src/types/GeneralTypes.ts:82](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L82) +[src/types/GeneralTypes.ts:82](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L82) diff --git a/docs/nevermined-sdk/api-reference/interfaces/TypedDataTypes.md b/docs/nevermined-sdk/api-reference/interfaces/TypedDataTypes.md index c8fa0cbc9c..df55a2cff5 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/TypedDataTypes.md +++ b/docs/nevermined-sdk/api-reference/interfaces/TypedDataTypes.md @@ -12,8 +12,8 @@ ### Nevermined -• **Nevermined**: \{ `name`: `string` ; `type`: `string` }[] +• **Nevermined**: \{ `name`: `string` ; `type`: `string` }[] #### Defined in -[src/types/GeneralTypes.ts:87](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L87) +[src/types/GeneralTypes.ts:87](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L87) diff --git a/docs/nevermined-sdk/api-reference/interfaces/UsedEvent.md b/docs/nevermined-sdk/api-reference/interfaces/UsedEvent.md index fc25a008a8..d53e5373e2 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/UsedEvent.md +++ b/docs/nevermined-sdk/api-reference/interfaces/UsedEvent.md @@ -33,9 +33,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:53](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L53) +[src/keeper/contracts/Provenance.ts:53](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L53) ---- +___ ### agentId @@ -43,9 +43,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:64](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L64) +[src/keeper/contracts/Provenance.ts:64](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L64) ---- +___ ### attributes @@ -57,9 +57,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:55](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L55) +[src/keeper/contracts/Provenance.ts:55](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L55) ---- +___ ### blockNumberUpdated @@ -71,9 +71,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:56](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L56) +[src/keeper/contracts/Provenance.ts:56](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L56) ---- +___ ### did @@ -81,9 +81,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:63](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L63) +[src/keeper/contracts/Provenance.ts:63](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L63) ---- +___ ### event @@ -95,9 +95,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L51) +[src/keeper/contracts/Provenance.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L51) ---- +___ ### method @@ -109,9 +109,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L52) +[src/keeper/contracts/Provenance.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L52) ---- +___ ### provId @@ -123,4 +123,4 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:54](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L54) +[src/keeper/contracts/Provenance.ts:54](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L54) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ValidationParams.md b/docs/nevermined-sdk/api-reference/interfaces/ValidationParams.md index a980bad4cc..0358c61660 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ValidationParams.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ValidationParams.md @@ -6,28 +6,28 @@ ### Properties -- [agreement_id](ValidationParams.md#agreement_id) +- [agreement\_id](ValidationParams.md#agreement_id) - [babysig](ValidationParams.md#babysig) - [buyer](ValidationParams.md#buyer) -- [consumer_address](ValidationParams.md#consumer_address) +- [consumer\_address](ValidationParams.md#consumer_address) - [did](ValidationParams.md#did) - [duration](ValidationParams.md#duration) - [expiration](ValidationParams.md#expiration) -- [nft_amount](ValidationParams.md#nft_amount) -- [nft_holder](ValidationParams.md#nft_holder) -- [service_index](ValidationParams.md#service_index) +- [nft\_amount](ValidationParams.md#nft_amount) +- [nft\_holder](ValidationParams.md#nft_holder) +- [service\_index](ValidationParams.md#service_index) ## Properties -### agreement_id +### agreement\_id -• **agreement_id**: `string` +• **agreement\_id**: `string` #### Defined in -[src/types/DDOTypes.ts:782](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L782) +[src/types/DDOTypes.ts:782](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L782) ---- +___ ### babysig @@ -35,9 +35,9 @@ #### Defined in -[src/types/DDOTypes.ts:787](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L787) +[src/types/DDOTypes.ts:787](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L787) ---- +___ ### buyer @@ -45,19 +45,19 @@ #### Defined in -[src/types/DDOTypes.ts:786](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L786) +[src/types/DDOTypes.ts:786](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L786) ---- +___ -### consumer_address +### consumer\_address -• **consumer_address**: `string` +• **consumer\_address**: `string` #### Defined in -[src/types/DDOTypes.ts:785](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L785) +[src/types/DDOTypes.ts:785](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L785) ---- +___ ### did @@ -65,9 +65,9 @@ #### Defined in -[src/types/DDOTypes.ts:783](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L783) +[src/types/DDOTypes.ts:783](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L783) ---- +___ ### duration @@ -75,9 +75,9 @@ #### Defined in -[src/types/DDOTypes.ts:790](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L790) +[src/types/DDOTypes.ts:790](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L790) ---- +___ ### expiration @@ -85,34 +85,34 @@ #### Defined in -[src/types/DDOTypes.ts:791](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L791) +[src/types/DDOTypes.ts:791](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L791) ---- +___ -### nft_amount +### nft\_amount -• `Optional` **nft_amount**: `bigint` +• `Optional` **nft\_amount**: `bigint` #### Defined in -[src/types/DDOTypes.ts:788](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L788) +[src/types/DDOTypes.ts:788](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L788) ---- +___ -### nft_holder +### nft\_holder -• `Optional` **nft_holder**: `string` +• `Optional` **nft\_holder**: `string` #### Defined in -[src/types/DDOTypes.ts:789](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L789) +[src/types/DDOTypes.ts:789](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L789) ---- +___ -### service_index +### service\_index -• `Optional` **service_index**: `number` +• `Optional` **service\_index**: `number` #### Defined in -[src/types/DDOTypes.ts:784](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L784) +[src/types/DDOTypes.ts:784](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L784) diff --git a/docs/nevermined-sdk/api-reference/interfaces/ValuePair.md b/docs/nevermined-sdk/api-reference/interfaces/ValuePair.md index f557d9bcda..b384966bc3 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/ValuePair.md +++ b/docs/nevermined-sdk/api-reference/interfaces/ValuePair.md @@ -17,9 +17,9 @@ #### Defined in -[src/types/GeneralTypes.ts:53](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L53) +[src/types/GeneralTypes.ts:53](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L53) ---- +___ ### value @@ -27,4 +27,4 @@ #### Defined in -[src/types/GeneralTypes.ts:54](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/GeneralTypes.ts#L54) +[src/types/GeneralTypes.ts:54](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/GeneralTypes.ts#L54) diff --git a/docs/nevermined-sdk/api-reference/interfaces/WasAssociatedWithEvent.md b/docs/nevermined-sdk/api-reference/interfaces/WasAssociatedWithEvent.md index 2088b424f4..816080bb8c 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/WasAssociatedWithEvent.md +++ b/docs/nevermined-sdk/api-reference/interfaces/WasAssociatedWithEvent.md @@ -33,9 +33,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:53](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L53) +[src/keeper/contracts/Provenance.ts:53](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L53) ---- +___ ### agentId @@ -43,9 +43,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:73](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L73) +[src/keeper/contracts/Provenance.ts:73](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L73) ---- +___ ### attributes @@ -57,9 +57,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:55](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L55) +[src/keeper/contracts/Provenance.ts:55](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L55) ---- +___ ### blockNumberUpdated @@ -71,9 +71,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:56](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L56) +[src/keeper/contracts/Provenance.ts:56](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L56) ---- +___ ### entityDid @@ -81,9 +81,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:72](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L72) +[src/keeper/contracts/Provenance.ts:72](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L72) ---- +___ ### event @@ -95,9 +95,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L51) +[src/keeper/contracts/Provenance.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L51) ---- +___ ### method @@ -109,9 +109,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L52) +[src/keeper/contracts/Provenance.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L52) ---- +___ ### provId @@ -123,4 +123,4 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:54](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L54) +[src/keeper/contracts/Provenance.ts:54](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L54) diff --git a/docs/nevermined-sdk/api-reference/interfaces/WasDerivedFromEvent.md b/docs/nevermined-sdk/api-reference/interfaces/WasDerivedFromEvent.md index 2f3b7427c0..57713f58f1 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/WasDerivedFromEvent.md +++ b/docs/nevermined-sdk/api-reference/interfaces/WasDerivedFromEvent.md @@ -34,9 +34,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:53](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L53) +[src/keeper/contracts/Provenance.ts:53](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L53) ---- +___ ### agentId @@ -44,9 +44,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:69](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L69) +[src/keeper/contracts/Provenance.ts:69](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L69) ---- +___ ### attributes @@ -58,9 +58,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:55](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L55) +[src/keeper/contracts/Provenance.ts:55](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L55) ---- +___ ### blockNumberUpdated @@ -72,9 +72,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:56](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L56) +[src/keeper/contracts/Provenance.ts:56](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L56) ---- +___ ### event @@ -86,9 +86,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L51) +[src/keeper/contracts/Provenance.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L51) ---- +___ ### method @@ -100,9 +100,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L52) +[src/keeper/contracts/Provenance.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L52) ---- +___ ### newEntityDid @@ -110,9 +110,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:67](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L67) +[src/keeper/contracts/Provenance.ts:67](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L67) ---- +___ ### provId @@ -124,9 +124,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:54](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L54) +[src/keeper/contracts/Provenance.ts:54](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L54) ---- +___ ### usedEntityDid @@ -134,4 +134,4 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:68](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L68) +[src/keeper/contracts/Provenance.ts:68](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L68) diff --git a/docs/nevermined-sdk/api-reference/interfaces/WasGeneratedByEvent.md b/docs/nevermined-sdk/api-reference/interfaces/WasGeneratedByEvent.md index 5ac5228b0f..143e8577fe 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/WasGeneratedByEvent.md +++ b/docs/nevermined-sdk/api-reference/interfaces/WasGeneratedByEvent.md @@ -33,9 +33,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:53](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L53) +[src/keeper/contracts/Provenance.ts:53](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L53) ---- +___ ### agentId @@ -43,9 +43,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:60](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L60) +[src/keeper/contracts/Provenance.ts:60](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L60) ---- +___ ### attributes @@ -57,9 +57,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:55](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L55) +[src/keeper/contracts/Provenance.ts:55](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L55) ---- +___ ### blockNumberUpdated @@ -71,9 +71,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:56](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L56) +[src/keeper/contracts/Provenance.ts:56](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L56) ---- +___ ### did @@ -81,9 +81,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:59](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L59) +[src/keeper/contracts/Provenance.ts:59](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L59) ---- +___ ### event @@ -95,9 +95,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:51](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L51) +[src/keeper/contracts/Provenance.ts:51](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L51) ---- +___ ### method @@ -109,9 +109,9 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:52](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L52) +[src/keeper/contracts/Provenance.ts:52](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L52) ---- +___ ### provId @@ -123,4 +123,4 @@ #### Defined in -[src/keeper/contracts/Provenance.ts:54](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/keeper/contracts/Provenance.ts#L54) +[src/keeper/contracts/Provenance.ts:54](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/keeper/contracts/Provenance.ts#L54) diff --git a/docs/nevermined-sdk/api-reference/interfaces/Web3Clients.md b/docs/nevermined-sdk/api-reference/interfaces/Web3Clients.md index 6b9cfa1fef..df283f0e04 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/Web3Clients.md +++ b/docs/nevermined-sdk/api-reference/interfaces/Web3Clients.md @@ -18,9 +18,9 @@ #### Defined in -[src/Instantiable.abstract.ts:26](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L26) +[src/Instantiable.abstract.ts:26](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L26) ---- +___ ### public @@ -28,75 +28,75 @@ #### Type declaration -| Name | Type | Description | -| :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` | The Account of the Client. | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"block"` }\> | - | -| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | -| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: `"transaction"` }\> | - | -| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | -| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | -| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | -| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | -| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | -| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends `"pending"` ? `null` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends `"pending"` ? `null` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | -| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | -| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | -| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | -| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | -| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | -| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | -| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | -| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | -| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getGasPrice` | () => `Promise`\<`bigint`\> | - | -| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | -| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | -| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | -| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: `null` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | -| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | -| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | -| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | -| `key` | `string` | A key for the client. | -| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | -| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | -| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | -| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | -| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | -| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | -| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | -| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | -| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | -| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` | The Account of the Client. | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `call` | (`parameters`: `CallParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`CallReturnType`\> | - | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `createBlockFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"block"`` }\> | - | +| `createContractEventFilter` | \(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `createEventFilter` | \(`args?`: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>) => `Promise`\<\{ [K in string \| number \| symbol]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>[K] }\> | - | +| `createPendingTransactionFilter` | () => `Promise`\<\{ `id`: \`0x$\{string}\` ; `request`: `EIP1193RequestFn`\ ; `type`: ``"transaction"`` }\> | - | +| `estimateContractGas` | \(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\>) => `Promise`\<`bigint`\> | - | +| `estimateFeesPerGas` | \(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\>) => `Promise`\<`EstimateFeesPerGasReturnType`\> | - | +| `estimateGas` | (`args`: `EstimateGasParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `estimateMaxPriorityFeePerGas` | \(`args?`: \{ `chain`: ``null`` \| `TChainOverride` }) => `Promise`\<`bigint`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined`, `PublicRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `PublicActions`\<`Transport`, `undefined` \| `Chain`\>\> | - | +| `getBalance` | (`args`: `GetBalanceParameters`) => `Promise`\<`bigint`\> | - | +| `getBlobBaseFee` | () => `Promise`\<`bigint`\> | - | +| `getBlock` | \(`args?`: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\>) => `Promise`\<\{ `baseFeePerGas`: ``null`` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: \`0x$\{string}\` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `logsBloom`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `miner`: \`0x$\{string}\` ; `mixHash`: \`0x$\{string}\` ; `nonce`: `TBlockTag` extends ``"pending"`` ? ``null`` : \`0x$\{string}\` ; `number`: `TBlockTag` extends ``"pending"`` ? ``null`` : `bigint` ; `parentHash`: \`0x$\{string}\` ; `receiptsRoot`: \`0x$\{string}\` ; `sealFields`: \`0x$\{string}\`[] ; `sha3Uncles`: \`0x$\{string}\` ; `size`: `bigint` ; `stateRoot`: \`0x$\{string}\` ; `timestamp`: `bigint` ; `totalDifficulty`: ``null`` \| `bigint` ; `transactions`: `TIncludeTransactions` extends ``true`` ? (\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` })[] : \`0x$\{string}\`[] ; `transactionsRoot`: \`0x$\{string}\` ; `uncles`: \`0x$\{string}\`[] ; `withdrawals?`: `Withdrawal`[] ; `withdrawalsRoot?`: \`0x$\{string}\` }\> | - | +| `getBlockNumber` | (`args?`: `GetBlockNumberParameters`) => `Promise`\<`bigint`\> | - | +| `getBlockTransactionCount` | (`args?`: `GetBlockTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getBytecode` | (`args`: `GetBytecodeParameters`) => `Promise`\<`GetBytecodeReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getContractEvents` | \(`args`: `GetContractEventsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>) => `Promise`\<`GetContractEventsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> | - | +| `getEnsAddress` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `coinType?`: `number` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAddressReturnType`\> | - | +| `getEnsAvatar` | (`args`: \{ `assetGatewayUrls?`: `AssetGatewayUrls` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsAvatarReturnType`\> | - | +| `getEnsName` | (`args`: \{ `address`: \`0x$\{string}\` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsNameReturnType`\> | - | +| `getEnsResolver` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `name`: `string` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<\`0x$\{string}\`\> | - | +| `getEnsText` | (`args`: \{ `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `gatewayUrls?`: `string`[] ; `key`: `string` ; `name`: `string` ; `strict?`: `boolean` ; `universalResolverAddress?`: \`0x$\{string}\` }) => `Promise`\<`GetEnsTextReturnType`\> | - | +| `getFeeHistory` | (`args`: `GetFeeHistoryParameters`) => `Promise`\<`GetFeeHistoryReturnType`\> | - | +| `getFilterChanges` | \(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getFilterLogs` | \(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getGasPrice` | () => `Promise`\<`bigint`\> | - | +| `getLogs` | \(`args?`: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> | - | +| `getProof` | (`args`: `GetProofParameters`) => `Promise`\<`GetProofReturnType`\> | - | +| `getStorageAt` | (`args`: `GetStorageAtParameters`) => `Promise`\<`GetStorageAtReturnType`\> | - | +| `getTransaction` | \(`args`: `GetTransactionParameters`\<`TBlockTag`\>) => `Promise`\<\{ `accessList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId?`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"legacy"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip2930"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip1559"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| \{ `accessList`: `AccessList` ; `blobVersionedHashes`: \`0x$\{string}\`[] ; `blockHash`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : \`0x$\{string}\` ; `blockNumber`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `bigint` ; `chainId`: `number` ; `from`: \`0x$\{string}\` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: \`0x$\{string}\` ; `input`: \`0x$\{string}\` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: \`0x$\{string}\` ; `s`: \`0x$\{string}\` ; `to`: ``null`` \| \`0x$\{string}\` ; `transactionIndex`: `TBlockTag` extends ``"pending"`` ? ``true`` : ``false`` extends ``true`` ? ``null`` : `number` ; `type`: ``"eip4844"`` ; `typeHex`: ``null`` \| \`0x$\{string}\` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` }\> | - | +| `getTransactionConfirmations` | (`args`: `GetTransactionConfirmationsParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`bigint`\> | - | +| `getTransactionCount` | (`args`: `GetTransactionCountParameters`) => `Promise`\<`number`\> | - | +| `getTransactionReceipt` | (`args`: `GetTransactionReceiptParameters`) => `Promise`\<`TransactionReceipt`\> | - | +| `key` | `string` | A key for the client. | +| `multicall` | \(`args`: `MulticallParameters`\<`contracts`, `allowFailure`\>) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> | - | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `readContract` | \(`args`: `ReadContractParameters`\<`abi`, `functionName`, `args`\>) => `Promise`\<`ReadContractReturnType`\<`abi`, `functionName`, `args`\>\> | - | +| `request` | `EIP1193RequestFn`\<`PublicRpcSchema`\> | Request function wrapped with friendly error handling | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `simulateContract` | \(`args`: `SimulateContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `chainOverride`, `accountOverride`\>) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`\>\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `uninstallFilter` | (`args`: `UninstallFilterParameters`) => `Promise`\<`boolean`\> | - | +| `verifyMessage` | (`args`: `VerifyMessageParameters`) => `Promise`\<`boolean`\> | - | +| `verifyTypedData` | (`args`: `VerifyTypedDataParameters`) => `Promise`\<`boolean`\> | - | +| `waitForTransactionReceipt` | (`args`: `WaitForTransactionReceiptParameters`\<`undefined` \| `Chain`\>) => `Promise`\<`TransactionReceipt`\> | - | +| `watchBlockNumber` | (`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType` | - | +| `watchBlocks` | \(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\>) => `WatchBlocksReturnType` | - | +| `watchContractEvent` | \(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\>) => `WatchContractEventReturnType` | - | +| `watchEvent` | \(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\>) => `WatchEventReturnType` | - | +| `watchPendingTransactions` | (`args`: `WatchPendingTransactionsParameters`\<`Transport`\>) => `WatchPendingTransactionsReturnType` | - | #### Defined in -[src/Instantiable.abstract.ts:24](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L24) +[src/Instantiable.abstract.ts:24](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L24) ---- +___ ### wallet @@ -104,39 +104,39 @@ #### Type declaration -| Name | Type | Description | -| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | -| `account` | `undefined` \| `Account` | The Account of the Client. | -| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | -| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | -| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | -| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | -| `ccipRead?` | `false` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | -| `chain` | `undefined` \| `Chain` | Chain for the client. | -| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | -| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | -| `getChainId` | () => `Promise`\<`number`\> | - | -| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | -| `key` | `string` | A key for the client. | -| `name` | `string` | A name for the client. | -| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | -| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | -| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | -| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | -| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | -| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | -| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | -| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | -| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | -| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | -| `type` | `string` | The type of client. | -| `uid` | `string` | A unique ID for the client. | -| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | -| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `account` | `undefined` \| `Account` | The Account of the Client. | +| `addChain` | (`args`: `AddChainParameters`) => `Promise`\<`void`\> | - | +| `batch?` | \{ `multicall?`: `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } } | Flags for batch settings. | +| `batch.multicall?` | `boolean` \| \{ `batchSize?`: `number` ; `wait?`: `number` } | Toggle to enable `eth_call` multicall aggregation. | +| `cacheTime` | `number` | Time (in ms) that cached data will remain in memory. | +| `ccipRead?` | ``false`` \| \{ `request?`: (`parameters`: `CcipRequestParameters`) => `Promise`\<\`0x$\{string}\`\> } | [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. | +| `chain` | `undefined` \| `Chain` | Chain for the client. | +| `deployContract` | \(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `extend` | \(`fn`: (`client`: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\>) => `client`) => `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `WalletRpcSchema`, \{ [K in string \| number \| symbol]: client[K] } & `WalletActions`\<`undefined` \| `Chain`, `undefined` \| `Account`\>\> | - | +| `getAddresses` | () => `Promise`\<`GetAddressesReturnType`\> | - | +| `getChainId` | () => `Promise`\<`number`\> | - | +| `getPermissions` | () => `Promise`\<`GetPermissionsReturnType`\> | - | +| `key` | `string` | A key for the client. | +| `name` | `string` | A name for the client. | +| `pollingInterval` | `number` | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. | +| `prepareTransactionRequest` | \(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\>) => `Promise`\<\{ [K in string \| number \| symbol]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest["kzg"] ? Object : Pick\))[K] }\> | - | +| `request` | `EIP1193RequestFn`\<`WalletRpcSchema`\> | Request function wrapped with friendly error handling | +| `requestAddresses` | () => `Promise`\<`RequestAddressesReturnType`\> | - | +| `requestPermissions` | (`args`: \{ `eth_accounts`: `Record`\<`string`, `any`\> }) => `Promise`\<`RequestPermissionsReturnType`\> | - | +| `sendRawTransaction` | (`args`: `SendRawTransactionParameters`) => `Promise`\<\`0x$\{string}\`\> | - | +| `sendTransaction` | \(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signMessage` | (`args`: `SignMessageParameters`\<`undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `signTransaction` | \(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x02$\{string}\` \| \`0x01$\{string}\` \| \`0x03$\{string}\` \| `TransactionSerializedLegacy`\> | - | +| `signTypedData` | \(`args`: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `undefined` \| `Account`\>) => `Promise`\<\`0x$\{string}\`\> | - | +| `switchChain` | (`args`: `SwitchChainParameters`) => `Promise`\<`void`\> | - | +| `transport` | `TransportConfig`\<`string`, `EIP1193RequestFn`\> & `Record`\<`string`, `any`\> | The RPC transport | +| `type` | `string` | The type of client. | +| `uid` | `string` | A unique ID for the client. | +| `watchAsset` | (`args`: `WatchAssetParams`) => `Promise`\<`boolean`\> | - | +| `writeContract` | \(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`\>) => `Promise`\<\`0x$\{string}\`\> | - | #### Defined in -[src/Instantiable.abstract.ts:25](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/Instantiable.abstract.ts#L25) +[src/Instantiable.abstract.ts:25](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/Instantiable.abstract.ts#L25) diff --git a/docs/nevermined-sdk/api-reference/interfaces/WebService.md b/docs/nevermined-sdk/api-reference/interfaces/WebService.md index cd69dbb698..a4c49f6bb5 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/WebService.md +++ b/docs/nevermined-sdk/api-reference/interfaces/WebService.md @@ -23,9 +23,9 @@ Interface describing an asset of type `service` #### Defined in -[src/types/DDOTypes.ts:206](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L206) +[src/types/DDOTypes.ts:206](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L206) ---- +___ ### encryptedAttributes @@ -33,19 +33,19 @@ Interface describing an asset of type `service` #### Defined in -[src/types/DDOTypes.ts:204](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L204) +[src/types/DDOTypes.ts:204](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L204) ---- +___ ### endpoints -• `Optional` **endpoints**: \{ `[verb: string]`: `string`; }[] +• `Optional` **endpoints**: \{ `[verb: string]`: `string`; }[] #### Defined in -[src/types/DDOTypes.ts:198](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L198) +[src/types/DDOTypes.ts:198](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L198) ---- +___ ### internalAttributes @@ -53,9 +53,9 @@ Interface describing an asset of type `service` #### Defined in -[src/types/DDOTypes.ts:202](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L202) +[src/types/DDOTypes.ts:202](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L202) ---- +___ ### openEndpoints @@ -63,14 +63,14 @@ Interface describing an asset of type `service` #### Defined in -[src/types/DDOTypes.ts:200](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L200) +[src/types/DDOTypes.ts:200](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L200) ---- +___ ### type -• `Optional` **type**: `"Other"` \| `"RESTful"` \| `"GrapQL"` \| `"RPC"` +• `Optional` **type**: ``"Other"`` \| ``"RESTful"`` \| ``"GrapQL"`` \| ``"RPC"`` #### Defined in -[src/types/DDOTypes.ts:196](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L196) +[src/types/DDOTypes.ts:196](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L196) diff --git a/docs/nevermined-sdk/api-reference/interfaces/WebServiceInternalAttributes.md b/docs/nevermined-sdk/api-reference/interfaces/WebServiceInternalAttributes.md index 55191b7372..cf6eba5b53 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/WebServiceInternalAttributes.md +++ b/docs/nevermined-sdk/api-reference/interfaces/WebServiceInternalAttributes.md @@ -17,14 +17,14 @@ #### Defined in -[src/types/DDOTypes.ts:226](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L226) +[src/types/DDOTypes.ts:226](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L226) ---- +___ ### headers -• `Optional` **headers**: \{ `[verb: string]`: `string`; }[] +• `Optional` **headers**: \{ `[verb: string]`: `string`; }[] #### Defined in -[src/types/DDOTypes.ts:228](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L228) +[src/types/DDOTypes.ts:228](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L228) diff --git a/docs/nevermined-sdk/api-reference/interfaces/Workflow.md b/docs/nevermined-sdk/api-reference/interfaces/Workflow.md index ba23b56637..81f7f512ab 100644 --- a/docs/nevermined-sdk/api-reference/interfaces/Workflow.md +++ b/docs/nevermined-sdk/api-reference/interfaces/Workflow.md @@ -13,13 +13,13 @@ ### coordinationType -• **coordinationType**: `"argo"` \| `"fl-coordinator"` \| `"bacalhau"` +• **coordinationType**: ``"argo"`` \| ``"fl-coordinator"`` \| ``"bacalhau"`` #### Defined in -[src/types/DDOTypes.ts:62](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L62) +[src/types/DDOTypes.ts:62](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L62) ---- +___ ### stages @@ -27,4 +27,4 @@ #### Defined in -[src/types/DDOTypes.ts:63](https://github.com/nevermined-io/sdk-js/blob/e4809d494b1dd12cc268e67289765b571409560d/src/types/DDOTypes.ts#L63) +[src/types/DDOTypes.ts:63](https://github.com/nevermined-io/sdk-js/blob/4d0a0baa5afc98578a0eec8d32b14e61f501c376/src/types/DDOTypes.ts#L63) diff --git a/docs/nevermined-sdk/api-reference/interfaces/conditions.ConditionContext.md b/docs/nevermined-sdk/api-reference/interfaces/conditions.ConditionContext.md deleted file mode 100644 index 55d42adf01..0000000000 --- a/docs/nevermined-sdk/api-reference/interfaces/conditions.ConditionContext.md +++ /dev/null @@ -1,54 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / ConditionContext - -# Interface: ConditionContext - -[conditions](../modules/conditions.md).ConditionContext - -## Table of contents - -### Properties - -- [creator](conditions.ConditionContext.md#creator) -- [ddo](conditions.ConditionContext.md#ddo) -- [rewards](conditions.ConditionContext.md#rewards) -- [service](conditions.ConditionContext.md#service) - -## Properties - -### creator - -• **creator**: `string` - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L23) - -___ - -### ddo - -• **ddo**: [`DDO`](../classes/DDO.md) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L20) - -___ - -### rewards - -• **rewards**: `default` - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:22](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L22) - -___ - -### service - -• **service**: `ServiceCommon` - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L21) diff --git a/docs/nevermined-sdk/api-reference/interfaces/conditions.ConditionInstance.md b/docs/nevermined-sdk/api-reference/interfaces/conditions.ConditionInstance.md deleted file mode 100644 index 7ae1eb3623..0000000000 --- a/docs/nevermined-sdk/api-reference/interfaces/conditions.ConditionInstance.md +++ /dev/null @@ -1,123 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / ConditionInstance - -# Interface: ConditionInstance - -[conditions](../modules/conditions.md).ConditionInstance - -## Type parameters - -| Name | -| :------ | -| `Extra` | - -## Hierarchy - -- [`ConditionInstanceSmall`](conditions.ConditionInstanceSmall.md) - - ↳ **`ConditionInstance`** - -## Table of contents - -### Properties - -- [agreementId](conditions.ConditionInstance.md#agreementid) -- [condition](conditions.ConditionInstance.md#condition) -- [id](conditions.ConditionInstance.md#id) -- [list](conditions.ConditionInstance.md#list) -- [params](conditions.ConditionInstance.md#params) -- [seed](conditions.ConditionInstance.md#seed) - -## Properties - -### agreementId - -• **agreementId**: `string` - -#### Inherited from - -[ConditionInstanceSmall](conditions.ConditionInstanceSmall.md).[agreementId](conditions.ConditionInstanceSmall.md#agreementid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L35) - -___ - -### condition - -• **condition**: `string` - -#### Inherited from - -[ConditionInstanceSmall](conditions.ConditionInstanceSmall.md).[condition](conditions.ConditionInstanceSmall.md#condition) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:36](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L36) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[ConditionInstanceSmall](conditions.ConditionInstanceSmall.md).[id](conditions.ConditionInstanceSmall.md#id) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:34](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L34) - -___ - -### list - -• **list**: `any`[] - -#### Inherited from - -[ConditionInstanceSmall](conditions.ConditionInstanceSmall.md).[list](conditions.ConditionInstanceSmall.md#list) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L32) - -___ - -### params - -• **params**: (`method`: [`ConditionMethod`](../modules/conditions.md#conditionmethod), `arg`: `Extra`) => `Promise`<`any`[]\> - -#### Type declaration - -▸ (`method`, `arg`): `Promise`<`any`[]\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | -| `arg` | `Extra` | - -##### Returns - -`Promise`<`any`[]\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:40](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L40) - -___ - -### seed - -• **seed**: `string` - -#### Inherited from - -[ConditionInstanceSmall](conditions.ConditionInstanceSmall.md).[seed](conditions.ConditionInstanceSmall.md#seed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L33) diff --git a/docs/nevermined-sdk/api-reference/interfaces/conditions.ConditionInstanceSmall.md b/docs/nevermined-sdk/api-reference/interfaces/conditions.ConditionInstanceSmall.md deleted file mode 100644 index f1adfd8192..0000000000 --- a/docs/nevermined-sdk/api-reference/interfaces/conditions.ConditionInstanceSmall.md +++ /dev/null @@ -1,71 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / ConditionInstanceSmall - -# Interface: ConditionInstanceSmall - -[conditions](../modules/conditions.md).ConditionInstanceSmall - -## Hierarchy - -- **`ConditionInstanceSmall`** - - ↳ [`ConditionInstance`](conditions.ConditionInstance.md) - -## Table of contents - -### Properties - -- [agreementId](conditions.ConditionInstanceSmall.md#agreementid) -- [condition](conditions.ConditionInstanceSmall.md#condition) -- [id](conditions.ConditionInstanceSmall.md#id) -- [list](conditions.ConditionInstanceSmall.md#list) -- [seed](conditions.ConditionInstanceSmall.md#seed) - -## Properties - -### agreementId - -• **agreementId**: `string` - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L35) - -___ - -### condition - -• **condition**: `string` - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:36](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L36) - -___ - -### id - -• **id**: `string` - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:34](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L34) - -___ - -### list - -• **list**: `any`[] - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L32) - -___ - -### seed - -• **seed**: `string` - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L33) diff --git a/docs/nevermined-sdk/api-reference/interfaces/conditions.ConditionParameters.md b/docs/nevermined-sdk/api-reference/interfaces/conditions.ConditionParameters.md deleted file mode 100644 index 316a87e48e..0000000000 --- a/docs/nevermined-sdk/api-reference/interfaces/conditions.ConditionParameters.md +++ /dev/null @@ -1,53 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [conditions](../modules/conditions.md) / ConditionParameters - -# Interface: ConditionParameters - -[conditions](../modules/conditions.md).ConditionParameters - -## Type parameters - -| Name | -| :------ | -| `Extra` | - -## Table of contents - -### Properties - -- [list](conditions.ConditionParameters.md#list) -- [params](conditions.ConditionParameters.md#params) - -## Properties - -### list - -• **list**: `any`[] - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:27](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L27) - -___ - -### params - -• **params**: (`method`: [`ConditionMethod`](../modules/conditions.md#conditionmethod), `arg`: `Extra`) => `Promise`<`any`[]\> - -#### Type declaration - -▸ (`method`, `arg`): `Promise`<`any`[]\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | -| `arg` | `Extra` | - -##### Returns - -`Promise`<`any`[]\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L28) diff --git a/docs/nevermined-sdk/api-reference/interfaces/events.ContractEventSubscription.md b/docs/nevermined-sdk/api-reference/interfaces/events.ContractEventSubscription.md deleted file mode 100644 index d2495f1ac5..0000000000 --- a/docs/nevermined-sdk/api-reference/interfaces/events.ContractEventSubscription.md +++ /dev/null @@ -1,29 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [events](../modules/events.md) / ContractEventSubscription - -# Interface: ContractEventSubscription - -[events](../modules/events.md).ContractEventSubscription - -## Table of contents - -### Properties - -- [unsubscribe](events.ContractEventSubscription.md#unsubscribe) - -## Properties - -### unsubscribe - -• **unsubscribe**: () => `void` - -#### Type declaration - -▸ (): `void` - -##### Returns - -`void` - -#### Defined in - -[src/events/NeverminedEvent.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L23) diff --git a/docs/nevermined-sdk/api-reference/interfaces/events.EventEmitter.md b/docs/nevermined-sdk/api-reference/interfaces/events.EventEmitter.md deleted file mode 100644 index a1ac17bba6..0000000000 --- a/docs/nevermined-sdk/api-reference/interfaces/events.EventEmitter.md +++ /dev/null @@ -1,61 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [events](../modules/events.md) / EventEmitter - -# Interface: EventEmitter - -[events](../modules/events.md).EventEmitter - -## Table of contents - -### Properties - -- [subscribe](events.EventEmitter.md#subscribe) -- [unsubscribe](events.EventEmitter.md#unsubscribe) - -## Properties - -### subscribe - -• **subscribe**: (`callback`: () => `Promise`<`void`\>, `arg1`: () => `Promise`<`number`\>) => `void` - -#### Type declaration - -▸ (`callback`, `arg1`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | () => `Promise`<`void`\> | -| `arg1` | () => `Promise`<`number`\> | - -##### Returns - -`void` - -#### Defined in - -[src/events/NeverminedEvent.ts:18](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L18) - -___ - -### unsubscribe - -• **unsubscribe**: (`arg0`: () => `Promise`<`void`\>) => `void` - -#### Type declaration - -▸ (`arg0`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `arg0` | () => `Promise`<`void`\> | - -##### Returns - -`void` - -#### Defined in - -[src/events/NeverminedEvent.ts:19](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L19) diff --git a/docs/nevermined-sdk/api-reference/interfaces/events.EventOptions.md b/docs/nevermined-sdk/api-reference/interfaces/events.EventOptions.md deleted file mode 100644 index d7abf14ccb..0000000000 --- a/docs/nevermined-sdk/api-reference/interfaces/events.EventOptions.md +++ /dev/null @@ -1,87 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [events](../modules/events.md) / EventOptions - -# Interface: EventOptions - -[events](../modules/events.md).EventOptions - -## Table of contents - -### Properties - -- [eventName](events.EventOptions.md#eventname) -- [filterJsonRpc](events.EventOptions.md#filterjsonrpc) -- [filterSubgraph](events.EventOptions.md#filtersubgraph) -- [fromBlock](events.EventOptions.md#fromblock) -- [methodName](events.EventOptions.md#methodname) -- [result](events.EventOptions.md#result) -- [toBlock](events.EventOptions.md#toblock) - -## Properties - -### eventName - -• `Optional` **eventName**: `string` - -#### Defined in - -[src/events/NeverminedEvent.ts:9](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L9) - -___ - -### filterJsonRpc - -• `Optional` **filterJsonRpc**: [`Filter`](events.Filter.md) - -#### Defined in - -[src/events/NeverminedEvent.ts:10](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L10) - -___ - -### filterSubgraph - -• `Optional` **filterSubgraph**: `Record`<`string`, `unknown`\> - -#### Defined in - -[src/events/NeverminedEvent.ts:11](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L11) - -___ - -### fromBlock - -• `Optional` **fromBlock**: `string` \| `number` - -#### Defined in - -[src/events/NeverminedEvent.ts:13](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L13) - -___ - -### methodName - -• `Optional` **methodName**: `string` - -#### Defined in - -[src/events/NeverminedEvent.ts:8](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L8) - -___ - -### result - -• `Optional` **result**: `Record`<`string`, `unknown`\> - -#### Defined in - -[src/events/NeverminedEvent.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L12) - -___ - -### toBlock - -• `Optional` **toBlock**: `string` \| `number` - -#### Defined in - -[src/events/NeverminedEvent.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L14) diff --git a/docs/nevermined-sdk/api-reference/interfaces/events.Filter.md b/docs/nevermined-sdk/api-reference/interfaces/events.Filter.md deleted file mode 100644 index 96a575868a..0000000000 --- a/docs/nevermined-sdk/api-reference/interfaces/events.Filter.md +++ /dev/null @@ -1,9 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [events](../modules/events.md) / Filter - -# Interface: Filter - -[events](../modules/events.md).Filter - -## Indexable - -▪ [key: `string`]: `number` \| `string` \| `string`[] \| `number`[] diff --git a/docs/nevermined-sdk/api-reference/interfaces/templates.AgreementConditionsStatus.md b/docs/nevermined-sdk/api-reference/interfaces/templates.AgreementConditionsStatus.md deleted file mode 100644 index ec9897abef..0000000000 --- a/docs/nevermined-sdk/api-reference/interfaces/templates.AgreementConditionsStatus.md +++ /dev/null @@ -1,9 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [templates](../modules/templates.md) / AgreementConditionsStatus - -# Interface: AgreementConditionsStatus - -[templates](../modules/templates.md).AgreementConditionsStatus - -## Indexable - -▪ [condition: `string`]: { `blocked`: `boolean` ; `blockedBy`: `string`[] ; `condition`: `string` ; `contractName`: `string` ; `state`: [`ConditionState`](../enums/ConditionState.md) } diff --git a/docs/nevermined-sdk/api-reference/interfaces/templates.AgreementInstance.md b/docs/nevermined-sdk/api-reference/interfaces/templates.AgreementInstance.md deleted file mode 100644 index fdb39a54e2..0000000000 --- a/docs/nevermined-sdk/api-reference/interfaces/templates.AgreementInstance.md +++ /dev/null @@ -1,49 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [templates](../modules/templates.md) / AgreementInstance - -# Interface: AgreementInstance - -[templates](../modules/templates.md).AgreementInstance - -## Type parameters - -| Name | -| :------ | -| `Params` | - -## Table of contents - -### Properties - -- [agreementId](templates.AgreementInstance.md#agreementid) -- [instances](templates.AgreementInstance.md#instances) -- [list](templates.AgreementInstance.md#list) - -## Properties - -### agreementId - -• **agreementId**: `string` - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L50) - -___ - -### instances - -• **instances**: [`ConditionInstanceSmall`](conditions.ConditionInstanceSmall.md)[] - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) - -___ - -### list - -• **list**: `Params` - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:49](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L49) diff --git a/docs/nevermined-sdk/api-reference/interfaces/templates.PaymentData.md b/docs/nevermined-sdk/api-reference/interfaces/templates.PaymentData.md deleted file mode 100644 index c528c7fc4e..0000000000 --- a/docs/nevermined-sdk/api-reference/interfaces/templates.PaymentData.md +++ /dev/null @@ -1,54 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [templates](../modules/templates.md) / PaymentData - -# Interface: PaymentData - -[templates](../modules/templates.md).PaymentData - -## Table of contents - -### Properties - -- [amounts](templates.PaymentData.md#amounts) -- [receivers](templates.PaymentData.md#receivers) -- [rewardAddress](templates.PaymentData.md#rewardaddress) -- [tokenAddress](templates.PaymentData.md#tokenaddress) - -## Properties - -### amounts - -• **amounts**: `default`[] - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L57) - -___ - -### receivers - -• **receivers**: `string`[] - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:58](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L58) - -___ - -### rewardAddress - -• **rewardAddress**: `string` - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L55) - -___ - -### tokenAddress - -• **tokenAddress**: `string` - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:56](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L56) diff --git a/docs/nevermined-sdk/api-reference/modules/KeyTransfer.md b/docs/nevermined-sdk/api-reference/modules/KeyTransfer.md deleted file mode 100644 index f1bcde9138..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/KeyTransfer.md +++ /dev/null @@ -1,14 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / KeyTransfer - -# Namespace: KeyTransfer - -## Table of contents - -### Classes - -- [BabyjubPublicKey](../classes/KeyTransfer.BabyjubPublicKey.md) -- [MimcCipher](../classes/KeyTransfer.MimcCipher.md) - -### Interfaces - -- [Babysig](../interfaces/KeyTransfer.Babysig.md) diff --git a/docs/nevermined-sdk/api-reference/modules/conditions.md b/docs/nevermined-sdk/api-reference/modules/conditions.md deleted file mode 100644 index dfb84871ae..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/conditions.md +++ /dev/null @@ -1,80 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / conditions - -# Namespace: conditions - -## Table of contents - -### References - -- [Condition](conditions.md#condition) -- [ConditionState](conditions.md#conditionstate) - -### Classes - -- [AaveBorrowCondition](../classes/conditions.AaveBorrowCondition.md) -- [AaveCollateralDepositCondition](../classes/conditions.AaveCollateralDepositCondition.md) -- [AaveCollateralWithdrawCondition](../classes/conditions.AaveCollateralWithdrawCondition.md) -- [AaveRepayCondition](../classes/conditions.AaveRepayCondition.md) -- [AccessCondition](../classes/conditions.AccessCondition.md) -- [ComputeExecutionCondition](../classes/conditions.ComputeExecutionCondition.md) -- [ConditionSmall](../classes/conditions.ConditionSmall.md) -- [ConsumerCondition](../classes/conditions.ConsumerCondition.md) -- [DistributeNFTCollateralCondition](../classes/conditions.DistributeNFTCollateralCondition.md) -- [EscrowPaymentCondition](../classes/conditions.EscrowPaymentCondition.md) -- [LockPaymentCondition](../classes/conditions.LockPaymentCondition.md) -- [NFT721HolderCondition](../classes/conditions.NFT721HolderCondition.md) -- [NFT721LockCondition](../classes/conditions.NFT721LockCondition.md) -- [NFTAccessCondition](../classes/conditions.NFTAccessCondition.md) -- [NFTHolderCondition](../classes/conditions.NFTHolderCondition.md) -- [NFTLockCondition](../classes/conditions.NFTLockCondition.md) -- [ProviderCondition](../classes/conditions.ProviderCondition.md) -- [TransferDIDOwnershipCondition](../classes/conditions.TransferDIDOwnershipCondition.md) -- [TransferNFT721Condition](../classes/conditions.TransferNFT721Condition.md) -- [TransferNFTCondition](../classes/conditions.TransferNFTCondition.md) - -### Interfaces - -- [ConditionContext](../interfaces/conditions.ConditionContext.md) -- [ConditionInstance](../interfaces/conditions.ConditionInstance.md) -- [ConditionInstanceSmall](../interfaces/conditions.ConditionInstanceSmall.md) -- [ConditionParameters](../interfaces/conditions.ConditionParameters.md) - -### Type Aliases - -- [ConditionMethod](conditions.md#conditionmethod) - -### Variables - -- [conditionStateNames](conditions.md#conditionstatenames) - -## References - -### Condition - -Re-exports [Condition](../classes/Condition.md) - -___ - -### ConditionState - -Re-exports [ConditionState](../enums/ConditionState.md) - -## Type Aliases - -### ConditionMethod - -Ƭ **ConditionMethod**: ``"fulfill"`` \| ``"fulfillForDelegate"`` - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:17](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L17) - -## Variables - -### conditionStateNames - -• `Const` **conditionStateNames**: `string`[] - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:43](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L43) diff --git a/docs/nevermined-sdk/api-reference/modules/events.md b/docs/nevermined-sdk/api-reference/modules/events.md deleted file mode 100644 index 39bb563548..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/events.md +++ /dev/null @@ -1,33 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / events - -# Namespace: events - -## Table of contents - -### Classes - -- [ContractEvent](../classes/events.ContractEvent.md) -- [EventHandler](../classes/events.EventHandler.md) -- [NeverminedEvent](../classes/events.NeverminedEvent.md) -- [SubgraphEvent](../classes/events.SubgraphEvent.md) - -### Interfaces - -- [ContractEventSubscription](../interfaces/events.ContractEventSubscription.md) -- [EventEmitter](../interfaces/events.EventEmitter.md) -- [EventOptions](../interfaces/events.EventOptions.md) -- [Filter](../interfaces/events.Filter.md) - -### Type Aliases - -- [EventResult](events.md#eventresult) - -## Type Aliases - -### EventResult - -Ƭ **EventResult**: `Promise`<`any`[]\> - -#### Defined in - -[src/events/NeverminedEvent.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L26) diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.AaveBorrowCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.AaveBorrowCondition.md deleted file mode 100644 index e04cdca4b6..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.AaveBorrowCondition.md +++ /dev/null @@ -1,508 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / AaveBorrowCondition - -# Namespace: AaveBorrowCondition - -[subgraphs](subgraphs.md).AaveBorrowCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.AaveBorrowCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.AaveBorrowCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.AaveBorrowCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.AaveBorrowCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.AaveBorrowCondition.md#initializedargs) -- [InitializedFields](subgraphs.AaveBorrowCondition.md#initializedfields) -- [InitializedFilter](subgraphs.AaveBorrowCondition.md#initializedfilter) -- [InitializedResult](subgraphs.AaveBorrowCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.AaveBorrowCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AaveBorrowCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AaveBorrowCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AaveBorrowCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AaveBorrowCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.AaveBorrowCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.AaveBorrowCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.AaveBorrowCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.AaveBorrowCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.AaveBorrowCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AaveBorrowCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AaveBorrowCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveBorrowCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:60 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | ``true`` | -| `_conditionId` | ``true`` | -| `_did` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:54 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:20 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | `string` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:48 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveBorrowCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:91 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:87 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:65 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:83 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:9 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveBorrowCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:128 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:123 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:96 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:118 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:1 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveBorrowCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveBorrowCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveBorrowCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.AaveBorrowCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveBorrowCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:63 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveBorrowCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveBorrowCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveBorrowCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.AaveBorrowCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.AaveBorrowCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.AaveBorrowCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveBorrowCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:64 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveBorrowCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveBorrowCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveBorrowCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AaveBorrowCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveBorrowCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:94 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveBorrowCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveBorrowCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveBorrowCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AaveBorrowCondition.md#initializedfilter), [`InitializedResult`](subgraphs.AaveBorrowCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AaveBorrowCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveBorrowCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:95 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveBorrowCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveBorrowCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveBorrowCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveBorrowCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveBorrowCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:131 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveBorrowCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveBorrowCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveBorrowCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AaveBorrowCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AaveBorrowCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveBorrowCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveBorrowCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:132 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.AaveCollateralDepositCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.AaveCollateralDepositCondition.md deleted file mode 100644 index d985b6f319..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.AaveCollateralDepositCondition.md +++ /dev/null @@ -1,508 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / AaveCollateralDepositCondition - -# Namespace: AaveCollateralDepositCondition - -[subgraphs](subgraphs.md).AaveCollateralDepositCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.AaveCollateralDepositCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.AaveCollateralDepositCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.AaveCollateralDepositCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.AaveCollateralDepositCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.AaveCollateralDepositCondition.md#initializedargs) -- [InitializedFields](subgraphs.AaveCollateralDepositCondition.md#initializedfields) -- [InitializedFilter](subgraphs.AaveCollateralDepositCondition.md#initializedfilter) -- [InitializedResult](subgraphs.AaveCollateralDepositCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.AaveCollateralDepositCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.AaveCollateralDepositCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.AaveCollateralDepositCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.AaveCollateralDepositCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.AaveCollateralDepositCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.AaveCollateralDepositCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AaveCollateralDepositCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AaveCollateralDepositCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveCollateralDepositCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:60 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | ``true`` | -| `_conditionId` | ``true`` | -| `_did` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:54 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:20 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | `string` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:48 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveCollateralDepositCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:91 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:87 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:65 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:83 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:9 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:128 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:123 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:96 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:118 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:1 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveCollateralDepositCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveCollateralDepositCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCollateralDepositCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.AaveCollateralDepositCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveCollateralDepositCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:63 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveCollateralDepositCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveCollateralDepositCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCollateralDepositCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.AaveCollateralDepositCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.AaveCollateralDepositCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.AaveCollateralDepositCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveCollateralDepositCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:64 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCollateralDepositCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveCollateralDepositCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCollateralDepositCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AaveCollateralDepositCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCollateralDepositCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:94 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCollateralDepositCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveCollateralDepositCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCollateralDepositCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AaveCollateralDepositCondition.md#initializedfilter), [`InitializedResult`](subgraphs.AaveCollateralDepositCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AaveCollateralDepositCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCollateralDepositCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:95 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCollateralDepositCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:131 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCollateralDepositCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:132 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.AaveCollateralWithdrawCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.AaveCollateralWithdrawCondition.md deleted file mode 100644 index 0e661829d9..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.AaveCollateralWithdrawCondition.md +++ /dev/null @@ -1,508 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / AaveCollateralWithdrawCondition - -# Namespace: AaveCollateralWithdrawCondition - -[subgraphs](subgraphs.md).AaveCollateralWithdrawCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.AaveCollateralWithdrawCondition.md#initializedargs) -- [InitializedFields](subgraphs.AaveCollateralWithdrawCondition.md#initializedfields) -- [InitializedFilter](subgraphs.AaveCollateralWithdrawCondition.md#initializedfilter) -- [InitializedResult](subgraphs.AaveCollateralWithdrawCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.AaveCollateralWithdrawCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.AaveCollateralWithdrawCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.AaveCollateralWithdrawCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.AaveCollateralWithdrawCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.AaveCollateralWithdrawCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.AaveCollateralWithdrawCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AaveCollateralWithdrawCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AaveCollateralWithdrawCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:60 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | ``true`` | -| `_conditionId` | ``true`` | -| `_did` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:54 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:20 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | `string` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:48 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveCollateralWithdrawCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:91 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:87 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:65 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:83 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:9 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:128 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:123 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:96 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:118 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:1 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCollateralWithdrawCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:63 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCollateralWithdrawCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:64 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCollateralWithdrawCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveCollateralWithdrawCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCollateralWithdrawCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AaveCollateralWithdrawCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCollateralWithdrawCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:94 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCollateralWithdrawCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveCollateralWithdrawCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCollateralWithdrawCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AaveCollateralWithdrawCondition.md#initializedfilter), [`InitializedResult`](subgraphs.AaveCollateralWithdrawCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AaveCollateralWithdrawCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCollateralWithdrawCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:95 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCollateralWithdrawCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:131 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCollateralWithdrawCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:132 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.AaveCreditTemplate.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.AaveCreditTemplate.md deleted file mode 100644 index 7b8f60c794..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.AaveCreditTemplate.md +++ /dev/null @@ -1,729 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / AaveCreditTemplate - -# Namespace: AaveCreditTemplate - -[subgraphs](subgraphs.md).AaveCreditTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.AaveCreditTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.AaveCreditTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.AaveCreditTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.AaveCreditTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.AaveCreditTemplate.md#initializedargs) -- [InitializedFields](subgraphs.AaveCreditTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.AaveCreditTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.AaveCreditTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.AaveCreditTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AaveCreditTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AaveCreditTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AaveCreditTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AaveCreditTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.AaveCreditTemplate.md#singlequeryoptions) -- [VaultCreatedArgs](subgraphs.AaveCreditTemplate.md#vaultcreatedargs) -- [VaultCreatedFields](subgraphs.AaveCreditTemplate.md#vaultcreatedfields) -- [VaultCreatedFilter](subgraphs.AaveCreditTemplate.md#vaultcreatedfilter) -- [VaultCreatedResult](subgraphs.AaveCreditTemplate.md#vaultcreatedresult) - -### Functions - -- [getAgreementCreatedById](subgraphs.AaveCreditTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.AaveCreditTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.AaveCreditTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.AaveCreditTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AaveCreditTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AaveCreditTemplate.md#getownershiptransferreds) -- [getVaultCreatedById](subgraphs.AaveCreditTemplate.md#getvaultcreatedbyid) -- [getVaultCreateds](subgraphs.AaveCreditTemplate.md#getvaultcreateds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.AaveCreditTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:117 - -___ - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | ``true`` | -| `_accessProvider` | ``true`` | -| `_agreementId` | ``true`` | -| `_conditionIdSeeds` | ``true`` | -| `_conditionIds` | ``true`` | -| `_creator` | ``true`` | -| `_did` | ``true`` | -| `_idSeed` | ``true`` | -| `_timeLocks` | ``true`` | -| `_timeOuts` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:104 - -___ - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer?` | `string` \| ``null`` | -| `_accessConsumer_contains?` | `string` \| ``null`` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| ``null`` | -| `_accessConsumer_not_contains?` | `string` \| ``null`` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| ``null`` | -| `_accessProvider_contains?` | `string` \| ``null`` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| ``null`` | -| `_accessProvider_not_contains?` | `string` \| ``null`` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| ``null`` | -| `_creator_contains?` | `string` \| ``null`` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| ``null`` | -| `_creator_not_contains?` | `string` \| ``null`` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| ``null`` | -| `_idSeed_contains?` | `string` \| ``null`` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| ``null`` | -| `_idSeed_not_contains?` | `string` \| ``null`` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:21 - -___ - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| ``null``)[] | -| `_conditionIds` | (`string` \| ``null``)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| ``null``)[] | -| `_timeOuts` | (`Wei` \| ``null``)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:91 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveCreditTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:148 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:144 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:122 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:140 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveCreditTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:185 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:180 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:153 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:175 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:2 - -___ - -### VaultCreatedArgs - -Ƭ **VaultCreatedArgs**<`K`\>: { [Property in keyof Pick]: VaultCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`VaultCreatedResult`](subgraphs.AaveCreditTemplate.md#vaultcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:238 - -___ - -### VaultCreatedFields - -Ƭ **VaultCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_borrower` | ``true`` | -| `_creator` | ``true`` | -| `_lender` | ``true`` | -| `_vaultAddress` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:231 - -___ - -### VaultCreatedFilter - -Ƭ **VaultCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_borrower?` | `string` \| ``null`` | -| `_borrower_contains?` | `string` \| ``null`` | -| `_borrower_in?` | `string`[] | -| `_borrower_not?` | `string` \| ``null`` | -| `_borrower_not_contains?` | `string` \| ``null`` | -| `_borrower_not_in?` | `string`[] | -| `_creator?` | `string` \| ``null`` | -| `_creator_contains?` | `string` \| ``null`` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| ``null`` | -| `_creator_not_contains?` | `string` \| ``null`` | -| `_creator_not_in?` | `string`[] | -| `_lender?` | `string` \| ``null`` | -| `_lender_contains?` | `string` \| ``null`` | -| `_lender_in?` | `string`[] | -| `_lender_not?` | `string` \| ``null`` | -| `_lender_not_contains?` | `string` \| ``null`` | -| `_lender_not_in?` | `string`[] | -| `_vaultAddress?` | `string` \| ``null`` | -| `_vaultAddress_contains?` | `string` \| ``null`` | -| `_vaultAddress_in?` | `string`[] | -| `_vaultAddress_not?` | `string` \| ``null`` | -| `_vaultAddress_not_contains?` | `string` \| ``null`` | -| `_vaultAddress_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:190 - -___ - -### VaultCreatedResult - -Ƭ **VaultCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_borrower` | `string` | -| `_creator` | `string` | -| `_lender` | `string` | -| `_vaultAddress` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:224 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AaveCreditTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.AaveCreditTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCreditTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.AaveCreditTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AaveCreditTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:120 - -___ - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AaveCreditTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.AaveCreditTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCreditTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.AaveCreditTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.AaveCreditTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.AaveCreditTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AaveCreditTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:121 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCreditTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveCreditTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCreditTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AaveCreditTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCreditTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:151 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCreditTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveCreditTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCreditTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AaveCreditTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.AaveCreditTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AaveCreditTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCreditTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:152 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCreditTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveCreditTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCreditTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveCreditTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCreditTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:188 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCreditTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveCreditTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCreditTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AaveCreditTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AaveCreditTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveCreditTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCreditTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:189 - -___ - -### getVaultCreatedById - -▸ **getVaultCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`VaultCreatedResult`](subgraphs.AaveCreditTemplate.md#vaultcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`VaultCreatedResult`](subgraphs.AaveCreditTemplate.md#vaultcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCreditTemplate.md#singlequeryoptions) | -| `args` | [`VaultCreatedArgs`](subgraphs.AaveCreditTemplate.md#vaultcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`VaultCreatedResult`](subgraphs.AaveCreditTemplate.md#vaultcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:241 - -___ - -### getVaultCreateds - -▸ **getVaultCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`VaultCreatedResult`](subgraphs.AaveCreditTemplate.md#vaultcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`VaultCreatedResult`](subgraphs.AaveCreditTemplate.md#vaultcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCreditTemplate.md#multiqueryoptions)<[`VaultCreatedFilter`](subgraphs.AaveCreditTemplate.md#vaultcreatedfilter), [`VaultCreatedResult`](subgraphs.AaveCreditTemplate.md#vaultcreatedresult)\> | -| `args` | [`VaultCreatedArgs`](subgraphs.AaveCreditTemplate.md#vaultcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`VaultCreatedResult`](subgraphs.AaveCreditTemplate.md#vaultcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:242 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.AaveRepayCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.AaveRepayCondition.md deleted file mode 100644 index f5664f832f..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.AaveRepayCondition.md +++ /dev/null @@ -1,508 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / AaveRepayCondition - -# Namespace: AaveRepayCondition - -[subgraphs](subgraphs.md).AaveRepayCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.AaveRepayCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.AaveRepayCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.AaveRepayCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.AaveRepayCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.AaveRepayCondition.md#initializedargs) -- [InitializedFields](subgraphs.AaveRepayCondition.md#initializedfields) -- [InitializedFilter](subgraphs.AaveRepayCondition.md#initializedfilter) -- [InitializedResult](subgraphs.AaveRepayCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.AaveRepayCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AaveRepayCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AaveRepayCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AaveRepayCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AaveRepayCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.AaveRepayCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.AaveRepayCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.AaveRepayCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.AaveRepayCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.AaveRepayCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AaveRepayCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AaveRepayCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveRepayCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:60 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | ``true`` | -| `_conditionId` | ``true`` | -| `_did` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:54 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:20 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | `string` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:48 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveRepayCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:91 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:87 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:65 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:83 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:9 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveRepayCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:128 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:123 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:96 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:118 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:1 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveRepayCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveRepayCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveRepayCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.AaveRepayCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveRepayCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:63 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveRepayCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveRepayCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveRepayCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.AaveRepayCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.AaveRepayCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.AaveRepayCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveRepayCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:64 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveRepayCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveRepayCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveRepayCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AaveRepayCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveRepayCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:94 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveRepayCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveRepayCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveRepayCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AaveRepayCondition.md#initializedfilter), [`InitializedResult`](subgraphs.AaveRepayCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AaveRepayCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveRepayCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:95 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveRepayCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveRepayCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveRepayCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveRepayCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveRepayCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:131 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveRepayCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveRepayCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveRepayCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AaveRepayCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AaveRepayCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveRepayCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveRepayCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:132 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.AccessCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.AccessCondition.md deleted file mode 100644 index 9c324998b3..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.AccessCondition.md +++ /dev/null @@ -1,516 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / AccessCondition - -# Namespace: AccessCondition - -[subgraphs](subgraphs.md).AccessCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.AccessCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.AccessCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.AccessCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.AccessCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.AccessCondition.md#initializedargs) -- [InitializedFields](subgraphs.AccessCondition.md#initializedfields) -- [InitializedFilter](subgraphs.AccessCondition.md#initializedfilter) -- [InitializedResult](subgraphs.AccessCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.AccessCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AccessCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AccessCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AccessCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AccessCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.AccessCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.AccessCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.AccessCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.AccessCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.AccessCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AccessCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AccessCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AccessCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:68 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | ``true`` | -| `_conditionId` | ``true`` | -| `_documentId` | ``true`` | -| `_grantee` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:61 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_documentId?` | `string` \| ``null`` | -| `_documentId_contains?` | `string` \| ``null`` | -| `_documentId_in?` | `string`[] | -| `_documentId_not?` | `string` \| ``null`` | -| `_documentId_not_contains?` | `string` \| ``null`` | -| `_documentId_not_in?` | `string`[] | -| `_grantee?` | `string` \| ``null`` | -| `_grantee_contains?` | `string` \| ``null`` | -| `_grantee_in?` | `string`[] | -| `_grantee_not?` | `string` \| ``null`` | -| `_grantee_not_contains?` | `string` \| ``null`` | -| `_grantee_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:20 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | `string` | -| `_conditionId` | `string` | -| `_documentId` | `string` | -| `_grantee` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:54 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:99 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:95 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:73 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:91 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:9 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:136 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:131 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:104 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:126 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:1 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AccessCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AccessCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.AccessCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AccessCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:71 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AccessCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AccessCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.AccessCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.AccessCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.AccessCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AccessCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:72 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AccessCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:102 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AccessCondition.md#initializedfilter), [`InitializedResult`](subgraphs.AccessCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AccessCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:103 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AccessCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:139 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AccessCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AccessCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AccessCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:140 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.AccessProofCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.AccessProofCondition.md deleted file mode 100644 index 0bbe124288..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.AccessProofCondition.md +++ /dev/null @@ -1,542 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / AccessProofCondition - -# Namespace: AccessProofCondition - -[subgraphs](subgraphs.md).AccessProofCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.AccessProofCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.AccessProofCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.AccessProofCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.AccessProofCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.AccessProofCondition.md#initializedargs) -- [InitializedFields](subgraphs.AccessProofCondition.md#initializedfields) -- [InitializedFilter](subgraphs.AccessProofCondition.md#initializedfilter) -- [InitializedResult](subgraphs.AccessProofCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.AccessProofCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AccessProofCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AccessProofCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AccessProofCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AccessProofCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.AccessProofCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.AccessProofCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.AccessProofCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.AccessProofCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.AccessProofCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AccessProofCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AccessProofCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AccessProofCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:95 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | ``true`` | -| `_buyer` | ``true`` | -| `_cipher` | ``true`` | -| `_conditionId` | ``true`` | -| `_origHash` | ``true`` | -| `_proof` | ``true`` | -| `_provider` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:85 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_buyer?` | `WeiSource`[] | -| `_buyer_contains?` | `WeiSource`[] | -| `_buyer_contains_nocase?` | `WeiSource`[] | -| `_buyer_not?` | `WeiSource`[] | -| `_buyer_not_contains?` | `WeiSource`[] | -| `_buyer_not_contains_nocase?` | `WeiSource`[] | -| `_cipher?` | `WeiSource`[] | -| `_cipher_contains?` | `WeiSource`[] | -| `_cipher_contains_nocase?` | `WeiSource`[] | -| `_cipher_not?` | `WeiSource`[] | -| `_cipher_not_contains?` | `WeiSource`[] | -| `_cipher_not_contains_nocase?` | `WeiSource`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_origHash?` | `WeiSource` \| ``null`` | -| `_origHash_gt?` | `WeiSource` \| ``null`` | -| `_origHash_gte?` | `WeiSource` \| ``null`` | -| `_origHash_in?` | `WeiSource`[] | -| `_origHash_lt?` | `WeiSource` \| ``null`` | -| `_origHash_lte?` | `WeiSource` \| ``null`` | -| `_origHash_not?` | `WeiSource` \| ``null`` | -| `_origHash_not_in?` | `WeiSource`[] | -| `_proof?` | `string` \| ``null`` | -| `_proof_contains?` | `string` \| ``null`` | -| `_proof_in?` | `string`[] | -| `_proof_not?` | `string` \| ``null`` | -| `_proof_not_contains?` | `string` \| ``null`` | -| `_proof_not_in?` | `string`[] | -| `_provider?` | `WeiSource`[] | -| `_provider_contains?` | `WeiSource`[] | -| `_provider_contains_nocase?` | `WeiSource`[] | -| `_provider_not?` | `WeiSource`[] | -| `_provider_not_contains?` | `WeiSource`[] | -| `_provider_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:21 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | `string` | -| `_buyer` | (`Wei` \| ``null``)[] | -| `_cipher` | (`Wei` \| ``null``)[] | -| `_conditionId` | `string` | -| `_origHash` | `Wei` | -| `_proof` | `string` | -| `_provider` | (`Wei` \| ``null``)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:75 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessProofCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:126 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:122 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:100 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:118 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessProofCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:163 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:158 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:131 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:153 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AccessProofCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AccessProofCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessProofCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.AccessProofCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AccessProofCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:98 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AccessProofCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AccessProofCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessProofCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.AccessProofCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.AccessProofCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.AccessProofCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AccessProofCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:99 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessProofCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessProofCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessProofCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AccessProofCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessProofCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:129 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessProofCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessProofCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessProofCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AccessProofCondition.md#initializedfilter), [`InitializedResult`](subgraphs.AccessProofCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AccessProofCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessProofCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:130 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessProofCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessProofCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessProofCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AccessProofCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessProofCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:166 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessProofCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessProofCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessProofCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AccessProofCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AccessProofCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AccessProofCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessProofCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:167 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.AccessProofTemplate.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.AccessProofTemplate.md deleted file mode 100644 index 54c3a5a0ac..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.AccessProofTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / AccessProofTemplate - -# Namespace: AccessProofTemplate - -[subgraphs](subgraphs.md).AccessProofTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.AccessProofTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.AccessProofTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.AccessProofTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.AccessProofTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.AccessProofTemplate.md#initializedargs) -- [InitializedFields](subgraphs.AccessProofTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.AccessProofTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.AccessProofTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.AccessProofTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AccessProofTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AccessProofTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AccessProofTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AccessProofTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.AccessProofTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.AccessProofTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.AccessProofTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.AccessProofTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.AccessProofTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AccessProofTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AccessProofTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.AccessProofTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:117 - -___ - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | ``true`` | -| `_accessProvider` | ``true`` | -| `_agreementId` | ``true`` | -| `_conditionIdSeeds` | ``true`` | -| `_conditionIds` | ``true`` | -| `_creator` | ``true`` | -| `_did` | ``true`` | -| `_idSeed` | ``true`` | -| `_timeLocks` | ``true`` | -| `_timeOuts` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:104 - -___ - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer?` | `string` \| ``null`` | -| `_accessConsumer_contains?` | `string` \| ``null`` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| ``null`` | -| `_accessConsumer_not_contains?` | `string` \| ``null`` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| ``null`` | -| `_accessProvider_contains?` | `string` \| ``null`` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| ``null`` | -| `_accessProvider_not_contains?` | `string` \| ``null`` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| ``null`` | -| `_creator_contains?` | `string` \| ``null`` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| ``null`` | -| `_creator_not_contains?` | `string` \| ``null`` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| ``null`` | -| `_idSeed_contains?` | `string` \| ``null`` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| ``null`` | -| `_idSeed_not_contains?` | `string` \| ``null`` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:21 - -___ - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| ``null``)[] | -| `_conditionIds` | (`string` \| ``null``)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| ``null``)[] | -| `_timeOuts` | (`Wei` \| ``null``)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:91 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessProofTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:148 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:144 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:122 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:140 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessProofTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:185 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:180 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:153 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:175 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AccessProofTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.AccessProofTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessProofTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.AccessProofTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AccessProofTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:120 - -___ - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AccessProofTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.AccessProofTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessProofTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.AccessProofTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.AccessProofTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.AccessProofTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AccessProofTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:121 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessProofTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessProofTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessProofTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AccessProofTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessProofTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:151 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessProofTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessProofTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessProofTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AccessProofTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.AccessProofTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AccessProofTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessProofTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:152 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessProofTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessProofTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessProofTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AccessProofTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessProofTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:188 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessProofTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessProofTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessProofTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AccessProofTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AccessProofTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AccessProofTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessProofTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:189 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.AccessTemplate.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.AccessTemplate.md deleted file mode 100644 index 41ac49792d..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.AccessTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / AccessTemplate - -# Namespace: AccessTemplate - -[subgraphs](subgraphs.md).AccessTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.AccessTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.AccessTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.AccessTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.AccessTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.AccessTemplate.md#initializedargs) -- [InitializedFields](subgraphs.AccessTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.AccessTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.AccessTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.AccessTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AccessTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AccessTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AccessTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AccessTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.AccessTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.AccessTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.AccessTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.AccessTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.AccessTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AccessTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AccessTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.AccessTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:117 - -___ - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | ``true`` | -| `_accessProvider` | ``true`` | -| `_agreementId` | ``true`` | -| `_conditionIdSeeds` | ``true`` | -| `_conditionIds` | ``true`` | -| `_creator` | ``true`` | -| `_did` | ``true`` | -| `_idSeed` | ``true`` | -| `_timeLocks` | ``true`` | -| `_timeOuts` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:104 - -___ - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer?` | `string` \| ``null`` | -| `_accessConsumer_contains?` | `string` \| ``null`` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| ``null`` | -| `_accessConsumer_not_contains?` | `string` \| ``null`` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| ``null`` | -| `_accessProvider_contains?` | `string` \| ``null`` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| ``null`` | -| `_accessProvider_not_contains?` | `string` \| ``null`` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| ``null`` | -| `_creator_contains?` | `string` \| ``null`` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| ``null`` | -| `_creator_not_contains?` | `string` \| ``null`` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| ``null`` | -| `_idSeed_contains?` | `string` \| ``null`` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| ``null`` | -| `_idSeed_not_contains?` | `string` \| ``null`` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:21 - -___ - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| ``null``)[] | -| `_conditionIds` | (`string` \| ``null``)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| ``null``)[] | -| `_timeOuts` | (`Wei` \| ``null``)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:91 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:148 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:144 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:122 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:140 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:185 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:180 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:153 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:175 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.AccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.AccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:120 - -___ - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.AccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.AccessTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.AccessTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.AccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:121 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:151 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AccessTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.AccessTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:152 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:188 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AccessTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AccessTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:189 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.AgreementStoreManager.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.AgreementStoreManager.md deleted file mode 100644 index f651392458..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.AgreementStoreManager.md +++ /dev/null @@ -1,822 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / AgreementStoreManager - -# Namespace: AgreementStoreManager - -[subgraphs](subgraphs.md).AgreementStoreManager - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.AgreementStoreManager.md#initializedargs) -- [InitializedFields](subgraphs.AgreementStoreManager.md#initializedfields) -- [InitializedFilter](subgraphs.AgreementStoreManager.md#initializedfilter) -- [InitializedResult](subgraphs.AgreementStoreManager.md#initializedresult) -- [MultiQueryOptions](subgraphs.AgreementStoreManager.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AgreementStoreManager.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AgreementStoreManager.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AgreementStoreManager.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AgreementStoreManager.md#ownershiptransferredresult) -- [RoleAdminChangedArgs](subgraphs.AgreementStoreManager.md#roleadminchangedargs) -- [RoleAdminChangedFields](subgraphs.AgreementStoreManager.md#roleadminchangedfields) -- [RoleAdminChangedFilter](subgraphs.AgreementStoreManager.md#roleadminchangedfilter) -- [RoleAdminChangedResult](subgraphs.AgreementStoreManager.md#roleadminchangedresult) -- [RoleGrantedArgs](subgraphs.AgreementStoreManager.md#rolegrantedargs) -- [RoleGrantedFields](subgraphs.AgreementStoreManager.md#rolegrantedfields) -- [RoleGrantedFilter](subgraphs.AgreementStoreManager.md#rolegrantedfilter) -- [RoleGrantedResult](subgraphs.AgreementStoreManager.md#rolegrantedresult) -- [RoleRevokedArgs](subgraphs.AgreementStoreManager.md#rolerevokedargs) -- [RoleRevokedFields](subgraphs.AgreementStoreManager.md#rolerevokedfields) -- [RoleRevokedFilter](subgraphs.AgreementStoreManager.md#rolerevokedfilter) -- [RoleRevokedResult](subgraphs.AgreementStoreManager.md#rolerevokedresult) -- [SingleQueryOptions](subgraphs.AgreementStoreManager.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.AgreementStoreManager.md#getinitializedbyid) -- [getInitializeds](subgraphs.AgreementStoreManager.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AgreementStoreManager.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AgreementStoreManager.md#getownershiptransferreds) -- [getRoleAdminChangedById](subgraphs.AgreementStoreManager.md#getroleadminchangedbyid) -- [getRoleAdminChangeds](subgraphs.AgreementStoreManager.md#getroleadminchangeds) -- [getRoleGrantedById](subgraphs.AgreementStoreManager.md#getrolegrantedbyid) -- [getRoleGranteds](subgraphs.AgreementStoreManager.md#getrolegranteds) -- [getRoleRevokedById](subgraphs.AgreementStoreManager.md#getrolerevokedbyid) -- [getRoleRevokeds](subgraphs.AgreementStoreManager.md#getrolerevokeds) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AgreementStoreManager.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:46 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:42 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:20 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:38 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:9 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AgreementStoreManager.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:83 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:78 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:51 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:73 - -___ - -### RoleAdminChangedArgs - -Ƭ **RoleAdminChangedArgs**<`K`\>: { [Property in keyof Pick]: RoleAdminChangedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.AgreementStoreManager.md#roleadminchangedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:128 - -___ - -### RoleAdminChangedFields - -Ƭ **RoleAdminChangedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newAdminRole` | ``true`` | -| `previousAdminRole` | ``true`` | -| `role` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:122 - -___ - -### RoleAdminChangedFilter - -Ƭ **RoleAdminChangedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newAdminRole?` | `string` \| ``null`` | -| `newAdminRole_contains?` | `string` \| ``null`` | -| `newAdminRole_in?` | `string`[] | -| `newAdminRole_not?` | `string` \| ``null`` | -| `newAdminRole_not_contains?` | `string` \| ``null`` | -| `newAdminRole_not_in?` | `string`[] | -| `previousAdminRole?` | `string` \| ``null`` | -| `previousAdminRole_contains?` | `string` \| ``null`` | -| `previousAdminRole_in?` | `string`[] | -| `previousAdminRole_not?` | `string` \| ``null`` | -| `previousAdminRole_not_contains?` | `string` \| ``null`` | -| `previousAdminRole_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:88 - -___ - -### RoleAdminChangedResult - -Ƭ **RoleAdminChangedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newAdminRole` | `string` | -| `previousAdminRole` | `string` | -| `role` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:116 - -___ - -### RoleGrantedArgs - -Ƭ **RoleGrantedArgs**<`K`\>: { [Property in keyof Pick]: RoleGrantedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.AgreementStoreManager.md#rolegrantedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:173 - -___ - -### RoleGrantedFields - -Ƭ **RoleGrantedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | ``true`` | -| `id` | ``true`` | -| `role` | ``true`` | -| `sender` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:167 - -___ - -### RoleGrantedFilter - -Ƭ **RoleGrantedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account?` | `string` \| ``null`` | -| `account_contains?` | `string` \| ``null`` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| ``null`` | -| `account_not_contains?` | `string` \| ``null`` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| ``null`` | -| `sender_contains?` | `string` \| ``null`` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| ``null`` | -| `sender_not_contains?` | `string` \| ``null`` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:133 - -___ - -### RoleGrantedResult - -Ƭ **RoleGrantedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:161 - -___ - -### RoleRevokedArgs - -Ƭ **RoleRevokedArgs**<`K`\>: { [Property in keyof Pick]: RoleRevokedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.AgreementStoreManager.md#rolerevokedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:218 - -___ - -### RoleRevokedFields - -Ƭ **RoleRevokedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | ``true`` | -| `id` | ``true`` | -| `role` | ``true`` | -| `sender` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:212 - -___ - -### RoleRevokedFilter - -Ƭ **RoleRevokedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account?` | `string` \| ``null`` | -| `account_contains?` | `string` \| ``null`` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| ``null`` | -| `account_not_contains?` | `string` \| ``null`` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| ``null`` | -| `sender_contains?` | `string` \| ``null`` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| ``null`` | -| `sender_not_contains?` | `string` \| ``null`` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:178 - -___ - -### RoleRevokedResult - -Ƭ **RoleRevokedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:206 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:1 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AgreementStoreManager.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AgreementStoreManager.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AgreementStoreManager.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AgreementStoreManager.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AgreementStoreManager.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:49 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AgreementStoreManager.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.AgreementStoreManager.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AgreementStoreManager.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AgreementStoreManager.md#initializedfilter), [`InitializedResult`](subgraphs.AgreementStoreManager.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AgreementStoreManager.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AgreementStoreManager.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:50 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AgreementStoreManager.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AgreementStoreManager.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AgreementStoreManager.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AgreementStoreManager.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AgreementStoreManager.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:86 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AgreementStoreManager.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AgreementStoreManager.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AgreementStoreManager.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AgreementStoreManager.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AgreementStoreManager.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AgreementStoreManager.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AgreementStoreManager.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:87 - -___ - -### getRoleAdminChangedById - -▸ **getRoleAdminChangedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.AgreementStoreManager.md#roleadminchangedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.AgreementStoreManager.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AgreementStoreManager.md#singlequeryoptions) | -| `args` | [`RoleAdminChangedArgs`](subgraphs.AgreementStoreManager.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.AgreementStoreManager.md#roleadminchangedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:131 - -___ - -### getRoleAdminChangeds - -▸ **getRoleAdminChangeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.AgreementStoreManager.md#roleadminchangedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.AgreementStoreManager.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AgreementStoreManager.md#multiqueryoptions)<[`RoleAdminChangedFilter`](subgraphs.AgreementStoreManager.md#roleadminchangedfilter), [`RoleAdminChangedResult`](subgraphs.AgreementStoreManager.md#roleadminchangedresult)\> | -| `args` | [`RoleAdminChangedArgs`](subgraphs.AgreementStoreManager.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.AgreementStoreManager.md#roleadminchangedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:132 - -___ - -### getRoleGrantedById - -▸ **getRoleGrantedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.AgreementStoreManager.md#rolegrantedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.AgreementStoreManager.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AgreementStoreManager.md#singlequeryoptions) | -| `args` | [`RoleGrantedArgs`](subgraphs.AgreementStoreManager.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.AgreementStoreManager.md#rolegrantedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:176 - -___ - -### getRoleGranteds - -▸ **getRoleGranteds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.AgreementStoreManager.md#rolegrantedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.AgreementStoreManager.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AgreementStoreManager.md#multiqueryoptions)<[`RoleGrantedFilter`](subgraphs.AgreementStoreManager.md#rolegrantedfilter), [`RoleGrantedResult`](subgraphs.AgreementStoreManager.md#rolegrantedresult)\> | -| `args` | [`RoleGrantedArgs`](subgraphs.AgreementStoreManager.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.AgreementStoreManager.md#rolegrantedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:177 - -___ - -### getRoleRevokedById - -▸ **getRoleRevokedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.AgreementStoreManager.md#rolerevokedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.AgreementStoreManager.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AgreementStoreManager.md#singlequeryoptions) | -| `args` | [`RoleRevokedArgs`](subgraphs.AgreementStoreManager.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.AgreementStoreManager.md#rolerevokedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:221 - -___ - -### getRoleRevokeds - -▸ **getRoleRevokeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.AgreementStoreManager.md#rolerevokedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.AgreementStoreManager.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AgreementStoreManager.md#multiqueryoptions)<[`RoleRevokedFilter`](subgraphs.AgreementStoreManager.md#rolerevokedfilter), [`RoleRevokedResult`](subgraphs.AgreementStoreManager.md#rolerevokedresult)\> | -| `args` | [`RoleRevokedArgs`](subgraphs.AgreementStoreManager.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.AgreementStoreManager.md#rolerevokedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:222 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.ComputeExecutionCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.ComputeExecutionCondition.md deleted file mode 100644 index 575cb0aa78..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.ComputeExecutionCondition.md +++ /dev/null @@ -1,516 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / ComputeExecutionCondition - -# Namespace: ComputeExecutionCondition - -[subgraphs](subgraphs.md).ComputeExecutionCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.ComputeExecutionCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.ComputeExecutionCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.ComputeExecutionCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.ComputeExecutionCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.ComputeExecutionCondition.md#initializedargs) -- [InitializedFields](subgraphs.ComputeExecutionCondition.md#initializedfields) -- [InitializedFilter](subgraphs.ComputeExecutionCondition.md#initializedfilter) -- [InitializedResult](subgraphs.ComputeExecutionCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.ComputeExecutionCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.ComputeExecutionCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.ComputeExecutionCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.ComputeExecutionCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.ComputeExecutionCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.ComputeExecutionCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.ComputeExecutionCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.ComputeExecutionCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.ComputeExecutionCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.ComputeExecutionCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.ComputeExecutionCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.ComputeExecutionCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.ComputeExecutionCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:68 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | ``true`` | -| `_computeConsumer` | ``true`` | -| `_conditionId` | ``true`` | -| `_did` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:61 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_computeConsumer?` | `string` \| ``null`` | -| `_computeConsumer_contains?` | `string` \| ``null`` | -| `_computeConsumer_in?` | `string`[] | -| `_computeConsumer_not?` | `string` \| ``null`` | -| `_computeConsumer_not_contains?` | `string` \| ``null`` | -| `_computeConsumer_not_in?` | `string`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:20 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | `string` | -| `_computeConsumer` | `string` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:54 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.ComputeExecutionCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:99 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:95 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:73 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:91 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:9 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:136 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:131 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:104 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:126 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:1 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.ComputeExecutionCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.ComputeExecutionCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ComputeExecutionCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.ComputeExecutionCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.ComputeExecutionCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:71 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.ComputeExecutionCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.ComputeExecutionCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ComputeExecutionCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.ComputeExecutionCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.ComputeExecutionCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.ComputeExecutionCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.ComputeExecutionCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:72 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.ComputeExecutionCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.ComputeExecutionCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ComputeExecutionCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.ComputeExecutionCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.ComputeExecutionCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:102 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.ComputeExecutionCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.ComputeExecutionCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ComputeExecutionCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.ComputeExecutionCondition.md#initializedfilter), [`InitializedResult`](subgraphs.ComputeExecutionCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.ComputeExecutionCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.ComputeExecutionCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:103 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ComputeExecutionCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:139 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ComputeExecutionCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:140 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.ConditionStoreManager.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.ConditionStoreManager.md deleted file mode 100644 index 34e8739836..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.ConditionStoreManager.md +++ /dev/null @@ -1,1130 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / ConditionStoreManager - -# Namespace: ConditionStoreManager - -[subgraphs](subgraphs.md).ConditionStoreManager - -## Table of contents - -### Type Aliases - -- [ConditionCreatedArgs](subgraphs.ConditionStoreManager.md#conditioncreatedargs) -- [ConditionCreatedFields](subgraphs.ConditionStoreManager.md#conditioncreatedfields) -- [ConditionCreatedFilter](subgraphs.ConditionStoreManager.md#conditioncreatedfilter) -- [ConditionCreatedResult](subgraphs.ConditionStoreManager.md#conditioncreatedresult) -- [ConditionUpdatedArgs](subgraphs.ConditionStoreManager.md#conditionupdatedargs) -- [ConditionUpdatedFields](subgraphs.ConditionStoreManager.md#conditionupdatedfields) -- [ConditionUpdatedFilter](subgraphs.ConditionStoreManager.md#conditionupdatedfilter) -- [ConditionUpdatedResult](subgraphs.ConditionStoreManager.md#conditionupdatedresult) -- [InitializedArgs](subgraphs.ConditionStoreManager.md#initializedargs) -- [InitializedFields](subgraphs.ConditionStoreManager.md#initializedfields) -- [InitializedFilter](subgraphs.ConditionStoreManager.md#initializedfilter) -- [InitializedResult](subgraphs.ConditionStoreManager.md#initializedresult) -- [MultiQueryOptions](subgraphs.ConditionStoreManager.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.ConditionStoreManager.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.ConditionStoreManager.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.ConditionStoreManager.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.ConditionStoreManager.md#ownershiptransferredresult) -- [RoleAdminChangedArgs](subgraphs.ConditionStoreManager.md#roleadminchangedargs) -- [RoleAdminChangedFields](subgraphs.ConditionStoreManager.md#roleadminchangedfields) -- [RoleAdminChangedFilter](subgraphs.ConditionStoreManager.md#roleadminchangedfilter) -- [RoleAdminChangedResult](subgraphs.ConditionStoreManager.md#roleadminchangedresult) -- [RoleGrantedArgs](subgraphs.ConditionStoreManager.md#rolegrantedargs) -- [RoleGrantedFields](subgraphs.ConditionStoreManager.md#rolegrantedfields) -- [RoleGrantedFilter](subgraphs.ConditionStoreManager.md#rolegrantedfilter) -- [RoleGrantedResult](subgraphs.ConditionStoreManager.md#rolegrantedresult) -- [RoleRevokedArgs](subgraphs.ConditionStoreManager.md#rolerevokedargs) -- [RoleRevokedFields](subgraphs.ConditionStoreManager.md#rolerevokedfields) -- [RoleRevokedFilter](subgraphs.ConditionStoreManager.md#rolerevokedfilter) -- [RoleRevokedResult](subgraphs.ConditionStoreManager.md#rolerevokedresult) -- [SingleQueryOptions](subgraphs.ConditionStoreManager.md#singlequeryoptions) - -### Functions - -- [getConditionCreatedById](subgraphs.ConditionStoreManager.md#getconditioncreatedbyid) -- [getConditionCreateds](subgraphs.ConditionStoreManager.md#getconditioncreateds) -- [getConditionUpdatedById](subgraphs.ConditionStoreManager.md#getconditionupdatedbyid) -- [getConditionUpdateds](subgraphs.ConditionStoreManager.md#getconditionupdateds) -- [getInitializedById](subgraphs.ConditionStoreManager.md#getinitializedbyid) -- [getInitializeds](subgraphs.ConditionStoreManager.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.ConditionStoreManager.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.ConditionStoreManager.md#getownershiptransferreds) -- [getRoleAdminChangedById](subgraphs.ConditionStoreManager.md#getroleadminchangedbyid) -- [getRoleAdminChangeds](subgraphs.ConditionStoreManager.md#getroleadminchangeds) -- [getRoleGrantedById](subgraphs.ConditionStoreManager.md#getrolegrantedbyid) -- [getRoleGranteds](subgraphs.ConditionStoreManager.md#getrolegranteds) -- [getRoleRevokedById](subgraphs.ConditionStoreManager.md#getrolerevokedbyid) -- [getRoleRevokeds](subgraphs.ConditionStoreManager.md#getrolerevokeds) - -## Type Aliases - -### ConditionCreatedArgs - -Ƭ **ConditionCreatedArgs**<`K`\>: { [Property in keyof Pick]: ConditionCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ConditionCreatedResult`](subgraphs.ConditionStoreManager.md#conditioncreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:52 - -___ - -### ConditionCreatedFields - -Ƭ **ConditionCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_typeRef` | ``true`` | -| `_who` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:47 - -___ - -### ConditionCreatedFilter - -Ƭ **ConditionCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_typeRef?` | `string` \| ``null`` | -| `_typeRef_contains?` | `string` \| ``null`` | -| `_typeRef_in?` | `string`[] | -| `_typeRef_not?` | `string` \| ``null`` | -| `_typeRef_not_contains?` | `string` \| ``null`` | -| `_typeRef_not_in?` | `string`[] | -| `_who?` | `string` \| ``null`` | -| `_who_contains?` | `string` \| ``null`` | -| `_who_in?` | `string`[] | -| `_who_not?` | `string` \| ``null`` | -| `_who_not_contains?` | `string` \| ``null`` | -| `_who_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:20 - -___ - -### ConditionCreatedResult - -Ƭ **ConditionCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_typeRef` | `string` | -| `_who` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:42 - -___ - -### ConditionUpdatedArgs - -Ƭ **ConditionUpdatedArgs**<`K`\>: { [Property in keyof Pick]: ConditionUpdatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ConditionUpdatedResult`](subgraphs.ConditionStoreManager.md#conditionupdatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:99 - -___ - -### ConditionUpdatedFields - -Ƭ **ConditionUpdatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_state` | ``true`` | -| `_typeRef` | ``true`` | -| `_who` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:93 - -___ - -### ConditionUpdatedFilter - -Ƭ **ConditionUpdatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_state?` | `number` \| ``null`` | -| `_state_gt?` | `number` \| ``null`` | -| `_state_gte?` | `number` \| ``null`` | -| `_state_in?` | `number`[] | -| `_state_lt?` | `number` \| ``null`` | -| `_state_lte?` | `number` \| ``null`` | -| `_state_not?` | `number` \| ``null`` | -| `_state_not_in?` | `number`[] | -| `_typeRef?` | `string` \| ``null`` | -| `_typeRef_contains?` | `string` \| ``null`` | -| `_typeRef_in?` | `string`[] | -| `_typeRef_not?` | `string` \| ``null`` | -| `_typeRef_not_contains?` | `string` \| ``null`` | -| `_typeRef_not_in?` | `string`[] | -| `_who?` | `string` \| ``null`` | -| `_who_contains?` | `string` \| ``null`` | -| `_who_in?` | `string`[] | -| `_who_not?` | `string` \| ``null`` | -| `_who_not_contains?` | `string` \| ``null`` | -| `_who_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:57 - -___ - -### ConditionUpdatedResult - -Ƭ **ConditionUpdatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_state` | `number` | -| `_typeRef` | `string` | -| `_who` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:87 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.ConditionStoreManager.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:130 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:126 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:104 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:122 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:9 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.ConditionStoreManager.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:167 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:162 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:135 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:157 - -___ - -### RoleAdminChangedArgs - -Ƭ **RoleAdminChangedArgs**<`K`\>: { [Property in keyof Pick]: RoleAdminChangedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.ConditionStoreManager.md#roleadminchangedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:212 - -___ - -### RoleAdminChangedFields - -Ƭ **RoleAdminChangedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newAdminRole` | ``true`` | -| `previousAdminRole` | ``true`` | -| `role` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:206 - -___ - -### RoleAdminChangedFilter - -Ƭ **RoleAdminChangedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newAdminRole?` | `string` \| ``null`` | -| `newAdminRole_contains?` | `string` \| ``null`` | -| `newAdminRole_in?` | `string`[] | -| `newAdminRole_not?` | `string` \| ``null`` | -| `newAdminRole_not_contains?` | `string` \| ``null`` | -| `newAdminRole_not_in?` | `string`[] | -| `previousAdminRole?` | `string` \| ``null`` | -| `previousAdminRole_contains?` | `string` \| ``null`` | -| `previousAdminRole_in?` | `string`[] | -| `previousAdminRole_not?` | `string` \| ``null`` | -| `previousAdminRole_not_contains?` | `string` \| ``null`` | -| `previousAdminRole_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:172 - -___ - -### RoleAdminChangedResult - -Ƭ **RoleAdminChangedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newAdminRole` | `string` | -| `previousAdminRole` | `string` | -| `role` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:200 - -___ - -### RoleGrantedArgs - -Ƭ **RoleGrantedArgs**<`K`\>: { [Property in keyof Pick]: RoleGrantedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.ConditionStoreManager.md#rolegrantedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:257 - -___ - -### RoleGrantedFields - -Ƭ **RoleGrantedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | ``true`` | -| `id` | ``true`` | -| `role` | ``true`` | -| `sender` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:251 - -___ - -### RoleGrantedFilter - -Ƭ **RoleGrantedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account?` | `string` \| ``null`` | -| `account_contains?` | `string` \| ``null`` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| ``null`` | -| `account_not_contains?` | `string` \| ``null`` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| ``null`` | -| `sender_contains?` | `string` \| ``null`` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| ``null`` | -| `sender_not_contains?` | `string` \| ``null`` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:217 - -___ - -### RoleGrantedResult - -Ƭ **RoleGrantedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:245 - -___ - -### RoleRevokedArgs - -Ƭ **RoleRevokedArgs**<`K`\>: { [Property in keyof Pick]: RoleRevokedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.ConditionStoreManager.md#rolerevokedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:302 - -___ - -### RoleRevokedFields - -Ƭ **RoleRevokedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | ``true`` | -| `id` | ``true`` | -| `role` | ``true`` | -| `sender` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:296 - -___ - -### RoleRevokedFilter - -Ƭ **RoleRevokedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account?` | `string` \| ``null`` | -| `account_contains?` | `string` \| ``null`` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| ``null`` | -| `account_not_contains?` | `string` \| ``null`` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| ``null`` | -| `sender_contains?` | `string` \| ``null`` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| ``null`` | -| `sender_not_contains?` | `string` \| ``null`` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:262 - -___ - -### RoleRevokedResult - -Ƭ **RoleRevokedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:290 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:1 - -## Functions - -### getConditionCreatedById - -▸ **getConditionCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ConditionCreatedResult`](subgraphs.ConditionStoreManager.md#conditioncreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ConditionCreatedResult`](subgraphs.ConditionStoreManager.md#conditioncreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ConditionStoreManager.md#singlequeryoptions) | -| `args` | [`ConditionCreatedArgs`](subgraphs.ConditionStoreManager.md#conditioncreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ConditionCreatedResult`](subgraphs.ConditionStoreManager.md#conditioncreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:55 - -___ - -### getConditionCreateds - -▸ **getConditionCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ConditionCreatedResult`](subgraphs.ConditionStoreManager.md#conditioncreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ConditionCreatedResult`](subgraphs.ConditionStoreManager.md#conditioncreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ConditionStoreManager.md#multiqueryoptions)<[`ConditionCreatedFilter`](subgraphs.ConditionStoreManager.md#conditioncreatedfilter), [`ConditionCreatedResult`](subgraphs.ConditionStoreManager.md#conditioncreatedresult)\> | -| `args` | [`ConditionCreatedArgs`](subgraphs.ConditionStoreManager.md#conditioncreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ConditionCreatedResult`](subgraphs.ConditionStoreManager.md#conditioncreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:56 - -___ - -### getConditionUpdatedById - -▸ **getConditionUpdatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ConditionUpdatedResult`](subgraphs.ConditionStoreManager.md#conditionupdatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ConditionUpdatedResult`](subgraphs.ConditionStoreManager.md#conditionupdatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ConditionStoreManager.md#singlequeryoptions) | -| `args` | [`ConditionUpdatedArgs`](subgraphs.ConditionStoreManager.md#conditionupdatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ConditionUpdatedResult`](subgraphs.ConditionStoreManager.md#conditionupdatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:102 - -___ - -### getConditionUpdateds - -▸ **getConditionUpdateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ConditionUpdatedResult`](subgraphs.ConditionStoreManager.md#conditionupdatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ConditionUpdatedResult`](subgraphs.ConditionStoreManager.md#conditionupdatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ConditionStoreManager.md#multiqueryoptions)<[`ConditionUpdatedFilter`](subgraphs.ConditionStoreManager.md#conditionupdatedfilter), [`ConditionUpdatedResult`](subgraphs.ConditionStoreManager.md#conditionupdatedresult)\> | -| `args` | [`ConditionUpdatedArgs`](subgraphs.ConditionStoreManager.md#conditionupdatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ConditionUpdatedResult`](subgraphs.ConditionStoreManager.md#conditionupdatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:103 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.ConditionStoreManager.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.ConditionStoreManager.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ConditionStoreManager.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.ConditionStoreManager.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.ConditionStoreManager.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:133 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.ConditionStoreManager.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.ConditionStoreManager.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ConditionStoreManager.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.ConditionStoreManager.md#initializedfilter), [`InitializedResult`](subgraphs.ConditionStoreManager.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.ConditionStoreManager.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.ConditionStoreManager.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:134 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ConditionStoreManager.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.ConditionStoreManager.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ConditionStoreManager.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.ConditionStoreManager.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ConditionStoreManager.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:170 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ConditionStoreManager.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.ConditionStoreManager.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ConditionStoreManager.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.ConditionStoreManager.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.ConditionStoreManager.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.ConditionStoreManager.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ConditionStoreManager.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:171 - -___ - -### getRoleAdminChangedById - -▸ **getRoleAdminChangedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.ConditionStoreManager.md#roleadminchangedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.ConditionStoreManager.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ConditionStoreManager.md#singlequeryoptions) | -| `args` | [`RoleAdminChangedArgs`](subgraphs.ConditionStoreManager.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.ConditionStoreManager.md#roleadminchangedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:215 - -___ - -### getRoleAdminChangeds - -▸ **getRoleAdminChangeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.ConditionStoreManager.md#roleadminchangedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.ConditionStoreManager.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ConditionStoreManager.md#multiqueryoptions)<[`RoleAdminChangedFilter`](subgraphs.ConditionStoreManager.md#roleadminchangedfilter), [`RoleAdminChangedResult`](subgraphs.ConditionStoreManager.md#roleadminchangedresult)\> | -| `args` | [`RoleAdminChangedArgs`](subgraphs.ConditionStoreManager.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.ConditionStoreManager.md#roleadminchangedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:216 - -___ - -### getRoleGrantedById - -▸ **getRoleGrantedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.ConditionStoreManager.md#rolegrantedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.ConditionStoreManager.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ConditionStoreManager.md#singlequeryoptions) | -| `args` | [`RoleGrantedArgs`](subgraphs.ConditionStoreManager.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.ConditionStoreManager.md#rolegrantedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:260 - -___ - -### getRoleGranteds - -▸ **getRoleGranteds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.ConditionStoreManager.md#rolegrantedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.ConditionStoreManager.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ConditionStoreManager.md#multiqueryoptions)<[`RoleGrantedFilter`](subgraphs.ConditionStoreManager.md#rolegrantedfilter), [`RoleGrantedResult`](subgraphs.ConditionStoreManager.md#rolegrantedresult)\> | -| `args` | [`RoleGrantedArgs`](subgraphs.ConditionStoreManager.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.ConditionStoreManager.md#rolegrantedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:261 - -___ - -### getRoleRevokedById - -▸ **getRoleRevokedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.ConditionStoreManager.md#rolerevokedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.ConditionStoreManager.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ConditionStoreManager.md#singlequeryoptions) | -| `args` | [`RoleRevokedArgs`](subgraphs.ConditionStoreManager.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.ConditionStoreManager.md#rolerevokedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:305 - -___ - -### getRoleRevokeds - -▸ **getRoleRevokeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.ConditionStoreManager.md#rolerevokedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.ConditionStoreManager.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ConditionStoreManager.md#multiqueryoptions)<[`RoleRevokedFilter`](subgraphs.ConditionStoreManager.md#rolerevokedfilter), [`RoleRevokedResult`](subgraphs.ConditionStoreManager.md#rolerevokedresult)\> | -| `args` | [`RoleRevokedArgs`](subgraphs.ConditionStoreManager.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.ConditionStoreManager.md#rolerevokedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:306 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.DIDRegistry.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.DIDRegistry.md deleted file mode 100644 index b4d87e217e..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.DIDRegistry.md +++ /dev/null @@ -1,3149 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / DIDRegistry - -# Namespace: DIDRegistry - -[subgraphs](subgraphs.md).DIDRegistry - -## Table of contents - -### Type Aliases - -- [ActedOnBehalfArgs](subgraphs.DIDRegistry.md#actedonbehalfargs) -- [ActedOnBehalfFields](subgraphs.DIDRegistry.md#actedonbehalffields) -- [ActedOnBehalfFilter](subgraphs.DIDRegistry.md#actedonbehalffilter) -- [ActedOnBehalfResult](subgraphs.DIDRegistry.md#actedonbehalfresult) -- [DIDAttributeRegisteredArgs](subgraphs.DIDRegistry.md#didattributeregisteredargs) -- [DIDAttributeRegisteredFields](subgraphs.DIDRegistry.md#didattributeregisteredfields) -- [DIDAttributeRegisteredFilter](subgraphs.DIDRegistry.md#didattributeregisteredfilter) -- [DIDAttributeRegisteredResult](subgraphs.DIDRegistry.md#didattributeregisteredresult) -- [DIDOwnershipTransferredArgs](subgraphs.DIDRegistry.md#didownershiptransferredargs) -- [DIDOwnershipTransferredFields](subgraphs.DIDRegistry.md#didownershiptransferredfields) -- [DIDOwnershipTransferredFilter](subgraphs.DIDRegistry.md#didownershiptransferredfilter) -- [DIDOwnershipTransferredResult](subgraphs.DIDRegistry.md#didownershiptransferredresult) -- [DIDPermissionGrantedArgs](subgraphs.DIDRegistry.md#didpermissiongrantedargs) -- [DIDPermissionGrantedFields](subgraphs.DIDRegistry.md#didpermissiongrantedfields) -- [DIDPermissionGrantedFilter](subgraphs.DIDRegistry.md#didpermissiongrantedfilter) -- [DIDPermissionGrantedResult](subgraphs.DIDRegistry.md#didpermissiongrantedresult) -- [DIDPermissionRevokedArgs](subgraphs.DIDRegistry.md#didpermissionrevokedargs) -- [DIDPermissionRevokedFields](subgraphs.DIDRegistry.md#didpermissionrevokedfields) -- [DIDPermissionRevokedFilter](subgraphs.DIDRegistry.md#didpermissionrevokedfilter) -- [DIDPermissionRevokedResult](subgraphs.DIDRegistry.md#didpermissionrevokedresult) -- [DIDProvenanceDelegateAddedArgs](subgraphs.DIDRegistry.md#didprovenancedelegateaddedargs) -- [DIDProvenanceDelegateAddedFields](subgraphs.DIDRegistry.md#didprovenancedelegateaddedfields) -- [DIDProvenanceDelegateAddedFilter](subgraphs.DIDRegistry.md#didprovenancedelegateaddedfilter) -- [DIDProvenanceDelegateAddedResult](subgraphs.DIDRegistry.md#didprovenancedelegateaddedresult) -- [DIDProvenanceDelegateRemovedArgs](subgraphs.DIDRegistry.md#didprovenancedelegateremovedargs) -- [DIDProvenanceDelegateRemovedFields](subgraphs.DIDRegistry.md#didprovenancedelegateremovedfields) -- [DIDProvenanceDelegateRemovedFilter](subgraphs.DIDRegistry.md#didprovenancedelegateremovedfilter) -- [DIDProvenanceDelegateRemovedResult](subgraphs.DIDRegistry.md#didprovenancedelegateremovedresult) -- [DIDProviderAddedArgs](subgraphs.DIDRegistry.md#didprovideraddedargs) -- [DIDProviderAddedFields](subgraphs.DIDRegistry.md#didprovideraddedfields) -- [DIDProviderAddedFilter](subgraphs.DIDRegistry.md#didprovideraddedfilter) -- [DIDProviderAddedResult](subgraphs.DIDRegistry.md#didprovideraddedresult) -- [DIDProviderRemovedArgs](subgraphs.DIDRegistry.md#didproviderremovedargs) -- [DIDProviderRemovedFields](subgraphs.DIDRegistry.md#didproviderremovedfields) -- [DIDProviderRemovedFilter](subgraphs.DIDRegistry.md#didproviderremovedfilter) -- [DIDProviderRemovedResult](subgraphs.DIDRegistry.md#didproviderremovedresult) -- [DIDRoyaltiesAddedArgs](subgraphs.DIDRegistry.md#didroyaltiesaddedargs) -- [DIDRoyaltiesAddedFields](subgraphs.DIDRegistry.md#didroyaltiesaddedfields) -- [DIDRoyaltiesAddedFilter](subgraphs.DIDRegistry.md#didroyaltiesaddedfilter) -- [DIDRoyaltiesAddedResult](subgraphs.DIDRegistry.md#didroyaltiesaddedresult) -- [DIDRoyaltyRecipientChangedArgs](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedargs) -- [DIDRoyaltyRecipientChangedFields](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedfields) -- [DIDRoyaltyRecipientChangedFilter](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedfilter) -- [DIDRoyaltyRecipientChangedResult](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedresult) -- [InitializedArgs](subgraphs.DIDRegistry.md#initializedargs) -- [InitializedFields](subgraphs.DIDRegistry.md#initializedfields) -- [InitializedFilter](subgraphs.DIDRegistry.md#initializedfilter) -- [InitializedResult](subgraphs.DIDRegistry.md#initializedresult) -- [MultiQueryOptions](subgraphs.DIDRegistry.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.DIDRegistry.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.DIDRegistry.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.DIDRegistry.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.DIDRegistry.md#ownershiptransferredresult) -- [ProvenanceAttributeRegisteredArgs](subgraphs.DIDRegistry.md#provenanceattributeregisteredargs) -- [ProvenanceAttributeRegisteredFields](subgraphs.DIDRegistry.md#provenanceattributeregisteredfields) -- [ProvenanceAttributeRegisteredFilter](subgraphs.DIDRegistry.md#provenanceattributeregisteredfilter) -- [ProvenanceAttributeRegisteredResult](subgraphs.DIDRegistry.md#provenanceattributeregisteredresult) -- [SingleQueryOptions](subgraphs.DIDRegistry.md#singlequeryoptions) -- [UsedArgs](subgraphs.DIDRegistry.md#usedargs) -- [UsedFields](subgraphs.DIDRegistry.md#usedfields) -- [UsedFilter](subgraphs.DIDRegistry.md#usedfilter) -- [UsedResult](subgraphs.DIDRegistry.md#usedresult) -- [WasAssociatedWithArgs](subgraphs.DIDRegistry.md#wasassociatedwithargs) -- [WasAssociatedWithFields](subgraphs.DIDRegistry.md#wasassociatedwithfields) -- [WasAssociatedWithFilter](subgraphs.DIDRegistry.md#wasassociatedwithfilter) -- [WasAssociatedWithResult](subgraphs.DIDRegistry.md#wasassociatedwithresult) -- [WasDerivedFromArgs](subgraphs.DIDRegistry.md#wasderivedfromargs) -- [WasDerivedFromFields](subgraphs.DIDRegistry.md#wasderivedfromfields) -- [WasDerivedFromFilter](subgraphs.DIDRegistry.md#wasderivedfromfilter) -- [WasDerivedFromResult](subgraphs.DIDRegistry.md#wasderivedfromresult) -- [WasGeneratedByArgs](subgraphs.DIDRegistry.md#wasgeneratedbyargs) -- [WasGeneratedByFields](subgraphs.DIDRegistry.md#wasgeneratedbyfields) -- [WasGeneratedByFilter](subgraphs.DIDRegistry.md#wasgeneratedbyfilter) -- [WasGeneratedByResult](subgraphs.DIDRegistry.md#wasgeneratedbyresult) - -### Functions - -- [getActedOnBehalfById](subgraphs.DIDRegistry.md#getactedonbehalfbyid) -- [getActedOnBehalfs](subgraphs.DIDRegistry.md#getactedonbehalfs) -- [getDIDAttributeRegisteredById](subgraphs.DIDRegistry.md#getdidattributeregisteredbyid) -- [getDIDAttributeRegistereds](subgraphs.DIDRegistry.md#getdidattributeregistereds) -- [getDIDOwnershipTransferredById](subgraphs.DIDRegistry.md#getdidownershiptransferredbyid) -- [getDIDOwnershipTransferreds](subgraphs.DIDRegistry.md#getdidownershiptransferreds) -- [getDIDPermissionGrantedById](subgraphs.DIDRegistry.md#getdidpermissiongrantedbyid) -- [getDIDPermissionGranteds](subgraphs.DIDRegistry.md#getdidpermissiongranteds) -- [getDIDPermissionRevokedById](subgraphs.DIDRegistry.md#getdidpermissionrevokedbyid) -- [getDIDPermissionRevokeds](subgraphs.DIDRegistry.md#getdidpermissionrevokeds) -- [getDIDProvenanceDelegateAddedById](subgraphs.DIDRegistry.md#getdidprovenancedelegateaddedbyid) -- [getDIDProvenanceDelegateAddeds](subgraphs.DIDRegistry.md#getdidprovenancedelegateaddeds) -- [getDIDProvenanceDelegateRemovedById](subgraphs.DIDRegistry.md#getdidprovenancedelegateremovedbyid) -- [getDIDProvenanceDelegateRemoveds](subgraphs.DIDRegistry.md#getdidprovenancedelegateremoveds) -- [getDIDProviderAddedById](subgraphs.DIDRegistry.md#getdidprovideraddedbyid) -- [getDIDProviderAddeds](subgraphs.DIDRegistry.md#getdidprovideraddeds) -- [getDIDProviderRemovedById](subgraphs.DIDRegistry.md#getdidproviderremovedbyid) -- [getDIDProviderRemoveds](subgraphs.DIDRegistry.md#getdidproviderremoveds) -- [getDIDRoyaltiesAddedById](subgraphs.DIDRegistry.md#getdidroyaltiesaddedbyid) -- [getDIDRoyaltiesAddeds](subgraphs.DIDRegistry.md#getdidroyaltiesaddeds) -- [getDIDRoyaltyRecipientChangedById](subgraphs.DIDRegistry.md#getdidroyaltyrecipientchangedbyid) -- [getDIDRoyaltyRecipientChangeds](subgraphs.DIDRegistry.md#getdidroyaltyrecipientchangeds) -- [getInitializedById](subgraphs.DIDRegistry.md#getinitializedbyid) -- [getInitializeds](subgraphs.DIDRegistry.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.DIDRegistry.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.DIDRegistry.md#getownershiptransferreds) -- [getProvenanceAttributeRegisteredById](subgraphs.DIDRegistry.md#getprovenanceattributeregisteredbyid) -- [getProvenanceAttributeRegistereds](subgraphs.DIDRegistry.md#getprovenanceattributeregistereds) -- [getUsedById](subgraphs.DIDRegistry.md#getusedbyid) -- [getUseds](subgraphs.DIDRegistry.md#getuseds) -- [getWasAssociatedWithById](subgraphs.DIDRegistry.md#getwasassociatedwithbyid) -- [getWasAssociatedWiths](subgraphs.DIDRegistry.md#getwasassociatedwiths) -- [getWasDerivedFromById](subgraphs.DIDRegistry.md#getwasderivedfrombyid) -- [getWasDerivedFroms](subgraphs.DIDRegistry.md#getwasderivedfroms) -- [getWasGeneratedByById](subgraphs.DIDRegistry.md#getwasgeneratedbybyid) -- [getWasGeneratedBys](subgraphs.DIDRegistry.md#getwasgeneratedbys) - -## Type Aliases - -### ActedOnBehalfArgs - -Ƭ **ActedOnBehalfArgs**<`K`\>: { [Property in keyof Pick]: ActedOnBehalfFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ActedOnBehalfResult`](subgraphs.DIDRegistry.md#actedonbehalfresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:109 - -___ - -### ActedOnBehalfFields - -Ƭ **ActedOnBehalfFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_activityId` | ``true`` | -| `_attributes` | ``true`` | -| `_blockNumberUpdated` | ``true`` | -| `_delegateAgentId` | ``true`` | -| `_entityDid` | ``true`` | -| `_responsibleAgentId` | ``true`` | -| `id` | ``true`` | -| `provId` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:99 - -___ - -### ActedOnBehalfFilter - -Ƭ **ActedOnBehalfFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_activityId?` | `string` \| ``null`` | -| `_activityId_contains?` | `string` \| ``null`` | -| `_activityId_in?` | `string`[] | -| `_activityId_not?` | `string` \| ``null`` | -| `_activityId_not_contains?` | `string` \| ``null`` | -| `_activityId_not_in?` | `string`[] | -| `_attributes?` | `string` \| ``null`` | -| `_attributes_contains?` | `string` \| ``null`` | -| `_attributes_contains_nocase?` | `string` \| ``null`` | -| `_attributes_ends_with?` | `string` \| ``null`` | -| `_attributes_ends_with_nocase?` | `string` \| ``null`` | -| `_attributes_gt?` | `string` \| ``null`` | -| `_attributes_gte?` | `string` \| ``null`` | -| `_attributes_in?` | `string`[] | -| `_attributes_lt?` | `string` \| ``null`` | -| `_attributes_lte?` | `string` \| ``null`` | -| `_attributes_not?` | `string` \| ``null`` | -| `_attributes_not_contains?` | `string` \| ``null`` | -| `_attributes_not_contains_nocase?` | `string` \| ``null`` | -| `_attributes_not_ends_with?` | `string` \| ``null`` | -| `_attributes_not_ends_with_nocase?` | `string` \| ``null`` | -| `_attributes_not_in?` | `string`[] | -| `_attributes_not_starts_with?` | `string` \| ``null`` | -| `_attributes_not_starts_with_nocase?` | `string` \| ``null`` | -| `_attributes_starts_with?` | `string` \| ``null`` | -| `_attributes_starts_with_nocase?` | `string` \| ``null`` | -| `_blockNumberUpdated?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_gt?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_gte?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_in?` | `WeiSource`[] | -| `_blockNumberUpdated_lt?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_lte?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_not?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_not_in?` | `WeiSource`[] | -| `_delegateAgentId?` | `string` \| ``null`` | -| `_delegateAgentId_contains?` | `string` \| ``null`` | -| `_delegateAgentId_in?` | `string`[] | -| `_delegateAgentId_not?` | `string` \| ``null`` | -| `_delegateAgentId_not_contains?` | `string` \| ``null`` | -| `_delegateAgentId_not_in?` | `string`[] | -| `_entityDid?` | `string` \| ``null`` | -| `_entityDid_contains?` | `string` \| ``null`` | -| `_entityDid_in?` | `string`[] | -| `_entityDid_not?` | `string` \| ``null`` | -| `_entityDid_not_contains?` | `string` \| ``null`` | -| `_entityDid_not_in?` | `string`[] | -| `_responsibleAgentId?` | `string` \| ``null`` | -| `_responsibleAgentId_contains?` | `string` \| ``null`` | -| `_responsibleAgentId_in?` | `string`[] | -| `_responsibleAgentId_not?` | `string` \| ``null`` | -| `_responsibleAgentId_not_contains?` | `string` \| ``null`` | -| `_responsibleAgentId_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `provId?` | `string` \| ``null`` | -| `provId_contains?` | `string` \| ``null`` | -| `provId_in?` | `string`[] | -| `provId_not?` | `string` \| ``null`` | -| `provId_not_contains?` | `string` \| ``null`` | -| `provId_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:21 - -___ - -### ActedOnBehalfResult - -Ƭ **ActedOnBehalfResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_activityId` | `string` | -| `_attributes` | `string` | -| `_blockNumberUpdated` | `Wei` | -| `_delegateAgentId` | `string` | -| `_entityDid` | `string` | -| `_responsibleAgentId` | `string` | -| `id` | `string` | -| `provId` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:89 - -___ - -### DIDAttributeRegisteredArgs - -Ƭ **DIDAttributeRegisteredArgs**<`K`\>: { [Property in keyof Pick]: DIDAttributeRegisteredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDAttributeRegisteredResult`](subgraphs.DIDRegistry.md#didattributeregisteredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:194 - -___ - -### DIDAttributeRegisteredFields - -Ƭ **DIDAttributeRegisteredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_blockNumberUpdated` | ``true`` | -| `_checksum` | ``true`` | -| `_did` | ``true`` | -| `_lastUpdatedBy` | ``true`` | -| `_owner` | ``true`` | -| `_value` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:185 - -___ - -### DIDAttributeRegisteredFilter - -Ƭ **DIDAttributeRegisteredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_blockNumberUpdated?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_gt?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_gte?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_in?` | `WeiSource`[] | -| `_blockNumberUpdated_lt?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_lte?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_not?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_not_in?` | `WeiSource`[] | -| `_checksum?` | `string` \| ``null`` | -| `_checksum_contains?` | `string` \| ``null`` | -| `_checksum_in?` | `string`[] | -| `_checksum_not?` | `string` \| ``null`` | -| `_checksum_not_contains?` | `string` \| ``null`` | -| `_checksum_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_lastUpdatedBy?` | `string` \| ``null`` | -| `_lastUpdatedBy_contains?` | `string` \| ``null`` | -| `_lastUpdatedBy_in?` | `string`[] | -| `_lastUpdatedBy_not?` | `string` \| ``null`` | -| `_lastUpdatedBy_not_contains?` | `string` \| ``null`` | -| `_lastUpdatedBy_not_in?` | `string`[] | -| `_owner?` | `string` \| ``null`` | -| `_owner_contains?` | `string` \| ``null`` | -| `_owner_in?` | `string`[] | -| `_owner_not?` | `string` \| ``null`` | -| `_owner_not_contains?` | `string` \| ``null`` | -| `_owner_not_in?` | `string`[] | -| `_value?` | `string` \| ``null`` | -| `_value_contains?` | `string` \| ``null`` | -| `_value_contains_nocase?` | `string` \| ``null`` | -| `_value_ends_with?` | `string` \| ``null`` | -| `_value_ends_with_nocase?` | `string` \| ``null`` | -| `_value_gt?` | `string` \| ``null`` | -| `_value_gte?` | `string` \| ``null`` | -| `_value_in?` | `string`[] | -| `_value_lt?` | `string` \| ``null`` | -| `_value_lte?` | `string` \| ``null`` | -| `_value_not?` | `string` \| ``null`` | -| `_value_not_contains?` | `string` \| ``null`` | -| `_value_not_contains_nocase?` | `string` \| ``null`` | -| `_value_not_ends_with?` | `string` \| ``null`` | -| `_value_not_ends_with_nocase?` | `string` \| ``null`` | -| `_value_not_in?` | `string`[] | -| `_value_not_starts_with?` | `string` \| ``null`` | -| `_value_not_starts_with_nocase?` | `string` \| ``null`` | -| `_value_starts_with?` | `string` \| ``null`` | -| `_value_starts_with_nocase?` | `string` \| ``null`` | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:114 - -___ - -### DIDAttributeRegisteredResult - -Ƭ **DIDAttributeRegisteredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_blockNumberUpdated` | `Wei` | -| `_checksum` | `string` | -| `_did` | `string` | -| `_lastUpdatedBy` | `string` | -| `_owner` | `string` | -| `_value` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:176 - -___ - -### DIDOwnershipTransferredArgs - -Ƭ **DIDOwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: DIDOwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDOwnershipTransferredResult`](subgraphs.DIDRegistry.md#didownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:239 - -___ - -### DIDOwnershipTransferredFields - -Ƭ **DIDOwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_did` | ``true`` | -| `_newOwner` | ``true`` | -| `_previousOwner` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:233 - -___ - -### DIDOwnershipTransferredFilter - -Ƭ **DIDOwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_newOwner?` | `string` \| ``null`` | -| `_newOwner_contains?` | `string` \| ``null`` | -| `_newOwner_in?` | `string`[] | -| `_newOwner_not?` | `string` \| ``null`` | -| `_newOwner_not_contains?` | `string` \| ``null`` | -| `_newOwner_not_in?` | `string`[] | -| `_previousOwner?` | `string` \| ``null`` | -| `_previousOwner_contains?` | `string` \| ``null`` | -| `_previousOwner_in?` | `string`[] | -| `_previousOwner_not?` | `string` \| ``null`` | -| `_previousOwner_not_contains?` | `string` \| ``null`` | -| `_previousOwner_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:199 - -___ - -### DIDOwnershipTransferredResult - -Ƭ **DIDOwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_did` | `string` | -| `_newOwner` | `string` | -| `_previousOwner` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:227 - -___ - -### DIDPermissionGrantedArgs - -Ƭ **DIDPermissionGrantedArgs**<`K`\>: { [Property in keyof Pick]: DIDPermissionGrantedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDPermissionGrantedResult`](subgraphs.DIDRegistry.md#didpermissiongrantedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:284 - -___ - -### DIDPermissionGrantedFields - -Ƭ **DIDPermissionGrantedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_did` | ``true`` | -| `_grantee` | ``true`` | -| `_owner` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:278 - -___ - -### DIDPermissionGrantedFilter - -Ƭ **DIDPermissionGrantedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_grantee?` | `string` \| ``null`` | -| `_grantee_contains?` | `string` \| ``null`` | -| `_grantee_in?` | `string`[] | -| `_grantee_not?` | `string` \| ``null`` | -| `_grantee_not_contains?` | `string` \| ``null`` | -| `_grantee_not_in?` | `string`[] | -| `_owner?` | `string` \| ``null`` | -| `_owner_contains?` | `string` \| ``null`` | -| `_owner_in?` | `string`[] | -| `_owner_not?` | `string` \| ``null`` | -| `_owner_not_contains?` | `string` \| ``null`` | -| `_owner_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:244 - -___ - -### DIDPermissionGrantedResult - -Ƭ **DIDPermissionGrantedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_did` | `string` | -| `_grantee` | `string` | -| `_owner` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:272 - -___ - -### DIDPermissionRevokedArgs - -Ƭ **DIDPermissionRevokedArgs**<`K`\>: { [Property in keyof Pick]: DIDPermissionRevokedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDPermissionRevokedResult`](subgraphs.DIDRegistry.md#didpermissionrevokedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:329 - -___ - -### DIDPermissionRevokedFields - -Ƭ **DIDPermissionRevokedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_did` | ``true`` | -| `_grantee` | ``true`` | -| `_owner` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:323 - -___ - -### DIDPermissionRevokedFilter - -Ƭ **DIDPermissionRevokedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_grantee?` | `string` \| ``null`` | -| `_grantee_contains?` | `string` \| ``null`` | -| `_grantee_in?` | `string`[] | -| `_grantee_not?` | `string` \| ``null`` | -| `_grantee_not_contains?` | `string` \| ``null`` | -| `_grantee_not_in?` | `string`[] | -| `_owner?` | `string` \| ``null`` | -| `_owner_contains?` | `string` \| ``null`` | -| `_owner_in?` | `string`[] | -| `_owner_not?` | `string` \| ``null`` | -| `_owner_not_contains?` | `string` \| ``null`` | -| `_owner_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:289 - -___ - -### DIDPermissionRevokedResult - -Ƭ **DIDPermissionRevokedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_did` | `string` | -| `_grantee` | `string` | -| `_owner` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:317 - -___ - -### DIDProvenanceDelegateAddedArgs - -Ƭ **DIDProvenanceDelegateAddedArgs**<`K`\>: { [Property in keyof Pick]: DIDProvenanceDelegateAddedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDProvenanceDelegateAddedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:366 - -___ - -### DIDProvenanceDelegateAddedFields - -Ƭ **DIDProvenanceDelegateAddedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_delegate` | ``true`` | -| `_did` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:361 - -___ - -### DIDProvenanceDelegateAddedFilter - -Ƭ **DIDProvenanceDelegateAddedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_delegate?` | `string` \| ``null`` | -| `_delegate_contains?` | `string` \| ``null`` | -| `_delegate_in?` | `string`[] | -| `_delegate_not?` | `string` \| ``null`` | -| `_delegate_not_contains?` | `string` \| ``null`` | -| `_delegate_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:334 - -___ - -### DIDProvenanceDelegateAddedResult - -Ƭ **DIDProvenanceDelegateAddedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_delegate` | `string` | -| `_did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:356 - -___ - -### DIDProvenanceDelegateRemovedArgs - -Ƭ **DIDProvenanceDelegateRemovedArgs**<`K`\>: { [Property in keyof Pick]: DIDProvenanceDelegateRemovedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDProvenanceDelegateRemovedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:409 - -___ - -### DIDProvenanceDelegateRemovedFields - -Ƭ **DIDProvenanceDelegateRemovedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_delegate` | ``true`` | -| `_did` | ``true`` | -| `id` | ``true`` | -| `state` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:403 - -___ - -### DIDProvenanceDelegateRemovedFilter - -Ƭ **DIDProvenanceDelegateRemovedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_delegate?` | `string` \| ``null`` | -| `_delegate_contains?` | `string` \| ``null`` | -| `_delegate_in?` | `string`[] | -| `_delegate_not?` | `string` \| ``null`` | -| `_delegate_not_contains?` | `string` \| ``null`` | -| `_delegate_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `state?` | `boolean` \| ``null`` | -| `state_in?` | `boolean`[] | -| `state_not?` | `boolean` \| ``null`` | -| `state_not_in?` | `boolean`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:371 - -___ - -### DIDProvenanceDelegateRemovedResult - -Ƭ **DIDProvenanceDelegateRemovedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_delegate` | `string` | -| `_did` | `string` | -| `id` | `string` | -| `state` | `boolean` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:397 - -___ - -### DIDProviderAddedArgs - -Ƭ **DIDProviderAddedArgs**<`K`\>: { [Property in keyof Pick]: DIDProviderAddedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDProviderAddedResult`](subgraphs.DIDRegistry.md#didprovideraddedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:446 - -___ - -### DIDProviderAddedFields - -Ƭ **DIDProviderAddedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_did` | ``true`` | -| `_provider` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:441 - -___ - -### DIDProviderAddedFilter - -Ƭ **DIDProviderAddedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_provider?` | `string` \| ``null`` | -| `_provider_contains?` | `string` \| ``null`` | -| `_provider_in?` | `string`[] | -| `_provider_not?` | `string` \| ``null`` | -| `_provider_not_contains?` | `string` \| ``null`` | -| `_provider_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:414 - -___ - -### DIDProviderAddedResult - -Ƭ **DIDProviderAddedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_did` | `string` | -| `_provider` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:436 - -___ - -### DIDProviderRemovedArgs - -Ƭ **DIDProviderRemovedArgs**<`K`\>: { [Property in keyof Pick]: DIDProviderRemovedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDProviderRemovedResult`](subgraphs.DIDRegistry.md#didproviderremovedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:489 - -___ - -### DIDProviderRemovedFields - -Ƭ **DIDProviderRemovedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_did` | ``true`` | -| `_provider` | ``true`` | -| `id` | ``true`` | -| `state` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:483 - -___ - -### DIDProviderRemovedFilter - -Ƭ **DIDProviderRemovedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_provider?` | `string` \| ``null`` | -| `_provider_contains?` | `string` \| ``null`` | -| `_provider_in?` | `string`[] | -| `_provider_not?` | `string` \| ``null`` | -| `_provider_not_contains?` | `string` \| ``null`` | -| `_provider_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `state?` | `boolean` \| ``null`` | -| `state_in?` | `boolean`[] | -| `state_not?` | `boolean` \| ``null`` | -| `state_not_in?` | `boolean`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:451 - -___ - -### DIDProviderRemovedResult - -Ƭ **DIDProviderRemovedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_did` | `string` | -| `_provider` | `string` | -| `id` | `string` | -| `state` | `boolean` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:477 - -___ - -### DIDRoyaltiesAddedArgs - -Ƭ **DIDRoyaltiesAddedArgs**<`K`\>: { [Property in keyof Pick]: DIDRoyaltiesAddedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDRoyaltiesAddedResult`](subgraphs.DIDRegistry.md#didroyaltiesaddedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:526 - -___ - -### DIDRoyaltiesAddedFields - -Ƭ **DIDRoyaltiesAddedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `addr` | ``true`` | -| `did` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:521 - -___ - -### DIDRoyaltiesAddedFilter - -Ƭ **DIDRoyaltiesAddedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `addr?` | `string` \| ``null`` | -| `addr_contains?` | `string` \| ``null`` | -| `addr_in?` | `string`[] | -| `addr_not?` | `string` \| ``null`` | -| `addr_not_contains?` | `string` \| ``null`` | -| `addr_not_in?` | `string`[] | -| `did?` | `string` \| ``null`` | -| `did_contains?` | `string` \| ``null`` | -| `did_in?` | `string`[] | -| `did_not?` | `string` \| ``null`` | -| `did_not_contains?` | `string` \| ``null`` | -| `did_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:494 - -___ - -### DIDRoyaltiesAddedResult - -Ƭ **DIDRoyaltiesAddedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `addr` | `string` | -| `did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:516 - -___ - -### DIDRoyaltyRecipientChangedArgs - -Ƭ **DIDRoyaltyRecipientChangedArgs**<`K`\>: { [Property in keyof Pick]: DIDRoyaltyRecipientChangedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDRoyaltyRecipientChangedResult`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:563 - -___ - -### DIDRoyaltyRecipientChangedFields - -Ƭ **DIDRoyaltyRecipientChangedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `addr` | ``true`` | -| `did` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:558 - -___ - -### DIDRoyaltyRecipientChangedFilter - -Ƭ **DIDRoyaltyRecipientChangedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `addr?` | `string` \| ``null`` | -| `addr_contains?` | `string` \| ``null`` | -| `addr_in?` | `string`[] | -| `addr_not?` | `string` \| ``null`` | -| `addr_not_contains?` | `string` \| ``null`` | -| `addr_not_in?` | `string`[] | -| `did?` | `string` \| ``null`` | -| `did_contains?` | `string` \| ``null`` | -| `did_in?` | `string`[] | -| `did_not?` | `string` \| ``null`` | -| `did_not_contains?` | `string` \| ``null`` | -| `did_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:531 - -___ - -### DIDRoyaltyRecipientChangedResult - -Ƭ **DIDRoyaltyRecipientChangedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `addr` | `string` | -| `did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:553 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.DIDRegistry.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:594 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:590 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:568 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:586 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.DIDRegistry.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:631 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:626 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:599 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:621 - -___ - -### ProvenanceAttributeRegisteredArgs - -Ƭ **ProvenanceAttributeRegisteredArgs**<`K`\>: { [Property in keyof Pick]: ProvenanceAttributeRegisteredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ProvenanceAttributeRegisteredResult`](subgraphs.DIDRegistry.md#provenanceattributeregisteredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:742 - -___ - -### ProvenanceAttributeRegisteredFields - -Ƭ **ProvenanceAttributeRegisteredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_activityId` | ``true`` | -| `_agentId` | ``true`` | -| `_agentInvolvedId` | ``true`` | -| `_attributes` | ``true`` | -| `_blockNumberUpdated` | ``true`` | -| `_did` | ``true`` | -| `_method` | ``true`` | -| `_relatedDid` | ``true`` | -| `id` | ``true`` | -| `provId` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:730 - -___ - -### ProvenanceAttributeRegisteredFilter - -Ƭ **ProvenanceAttributeRegisteredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_activityId?` | `string` \| ``null`` | -| `_activityId_contains?` | `string` \| ``null`` | -| `_activityId_in?` | `string`[] | -| `_activityId_not?` | `string` \| ``null`` | -| `_activityId_not_contains?` | `string` \| ``null`` | -| `_activityId_not_in?` | `string`[] | -| `_agentId?` | `string` \| ``null`` | -| `_agentId_contains?` | `string` \| ``null`` | -| `_agentId_in?` | `string`[] | -| `_agentId_not?` | `string` \| ``null`` | -| `_agentId_not_contains?` | `string` \| ``null`` | -| `_agentId_not_in?` | `string`[] | -| `_agentInvolvedId?` | `string` \| ``null`` | -| `_agentInvolvedId_contains?` | `string` \| ``null`` | -| `_agentInvolvedId_in?` | `string`[] | -| `_agentInvolvedId_not?` | `string` \| ``null`` | -| `_agentInvolvedId_not_contains?` | `string` \| ``null`` | -| `_agentInvolvedId_not_in?` | `string`[] | -| `_attributes?` | `string` \| ``null`` | -| `_attributes_contains?` | `string` \| ``null`` | -| `_attributes_contains_nocase?` | `string` \| ``null`` | -| `_attributes_ends_with?` | `string` \| ``null`` | -| `_attributes_ends_with_nocase?` | `string` \| ``null`` | -| `_attributes_gt?` | `string` \| ``null`` | -| `_attributes_gte?` | `string` \| ``null`` | -| `_attributes_in?` | `string`[] | -| `_attributes_lt?` | `string` \| ``null`` | -| `_attributes_lte?` | `string` \| ``null`` | -| `_attributes_not?` | `string` \| ``null`` | -| `_attributes_not_contains?` | `string` \| ``null`` | -| `_attributes_not_contains_nocase?` | `string` \| ``null`` | -| `_attributes_not_ends_with?` | `string` \| ``null`` | -| `_attributes_not_ends_with_nocase?` | `string` \| ``null`` | -| `_attributes_not_in?` | `string`[] | -| `_attributes_not_starts_with?` | `string` \| ``null`` | -| `_attributes_not_starts_with_nocase?` | `string` \| ``null`` | -| `_attributes_starts_with?` | `string` \| ``null`` | -| `_attributes_starts_with_nocase?` | `string` \| ``null`` | -| `_blockNumberUpdated?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_gt?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_gte?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_in?` | `WeiSource`[] | -| `_blockNumberUpdated_lt?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_lte?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_not?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_not_in?` | `WeiSource`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_method?` | `number` \| ``null`` | -| `_method_gt?` | `number` \| ``null`` | -| `_method_gte?` | `number` \| ``null`` | -| `_method_in?` | `number`[] | -| `_method_lt?` | `number` \| ``null`` | -| `_method_lte?` | `number` \| ``null`` | -| `_method_not?` | `number` \| ``null`` | -| `_method_not_in?` | `number`[] | -| `_relatedDid?` | `string` \| ``null`` | -| `_relatedDid_contains?` | `string` \| ``null`` | -| `_relatedDid_in?` | `string`[] | -| `_relatedDid_not?` | `string` \| ``null`` | -| `_relatedDid_not_contains?` | `string` \| ``null`` | -| `_relatedDid_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `provId?` | `string` \| ``null`` | -| `provId_contains?` | `string` \| ``null`` | -| `provId_in?` | `string`[] | -| `provId_not?` | `string` \| ``null`` | -| `provId_not_contains?` | `string` \| ``null`` | -| `provId_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:636 - -___ - -### ProvenanceAttributeRegisteredResult - -Ƭ **ProvenanceAttributeRegisteredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_activityId` | `string` | -| `_agentId` | `string` | -| `_agentInvolvedId` | `string` | -| `_attributes` | `string` | -| `_blockNumberUpdated` | `Wei` | -| `_did` | `string` | -| `_method` | `number` | -| `_relatedDid` | `string` | -| `id` | `string` | -| `provId` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:718 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:2 - -___ - -### UsedArgs - -Ƭ **UsedArgs**<`K`\>: { [Property in keyof Pick]: UsedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`UsedResult`](subgraphs.DIDRegistry.md#usedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:827 - -___ - -### UsedFields - -Ƭ **UsedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_activityId` | ``true`` | -| `_agentId` | ``true`` | -| `_attributes` | ``true`` | -| `_blockNumberUpdated` | ``true`` | -| `_did` | ``true`` | -| `id` | ``true`` | -| `provId` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:818 - -___ - -### UsedFilter - -Ƭ **UsedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_activityId?` | `string` \| ``null`` | -| `_activityId_contains?` | `string` \| ``null`` | -| `_activityId_in?` | `string`[] | -| `_activityId_not?` | `string` \| ``null`` | -| `_activityId_not_contains?` | `string` \| ``null`` | -| `_activityId_not_in?` | `string`[] | -| `_agentId?` | `string` \| ``null`` | -| `_agentId_contains?` | `string` \| ``null`` | -| `_agentId_in?` | `string`[] | -| `_agentId_not?` | `string` \| ``null`` | -| `_agentId_not_contains?` | `string` \| ``null`` | -| `_agentId_not_in?` | `string`[] | -| `_attributes?` | `string` \| ``null`` | -| `_attributes_contains?` | `string` \| ``null`` | -| `_attributes_contains_nocase?` | `string` \| ``null`` | -| `_attributes_ends_with?` | `string` \| ``null`` | -| `_attributes_ends_with_nocase?` | `string` \| ``null`` | -| `_attributes_gt?` | `string` \| ``null`` | -| `_attributes_gte?` | `string` \| ``null`` | -| `_attributes_in?` | `string`[] | -| `_attributes_lt?` | `string` \| ``null`` | -| `_attributes_lte?` | `string` \| ``null`` | -| `_attributes_not?` | `string` \| ``null`` | -| `_attributes_not_contains?` | `string` \| ``null`` | -| `_attributes_not_contains_nocase?` | `string` \| ``null`` | -| `_attributes_not_ends_with?` | `string` \| ``null`` | -| `_attributes_not_ends_with_nocase?` | `string` \| ``null`` | -| `_attributes_not_in?` | `string`[] | -| `_attributes_not_starts_with?` | `string` \| ``null`` | -| `_attributes_not_starts_with_nocase?` | `string` \| ``null`` | -| `_attributes_starts_with?` | `string` \| ``null`` | -| `_attributes_starts_with_nocase?` | `string` \| ``null`` | -| `_blockNumberUpdated?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_gt?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_gte?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_in?` | `WeiSource`[] | -| `_blockNumberUpdated_lt?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_lte?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_not?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_not_in?` | `WeiSource`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `provId?` | `string` \| ``null`` | -| `provId_contains?` | `string` \| ``null`` | -| `provId_in?` | `string`[] | -| `provId_not?` | `string` \| ``null`` | -| `provId_not_contains?` | `string` \| ``null`` | -| `provId_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:747 - -___ - -### UsedResult - -Ƭ **UsedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_activityId` | `string` | -| `_agentId` | `string` | -| `_attributes` | `string` | -| `_blockNumberUpdated` | `Wei` | -| `_did` | `string` | -| `id` | `string` | -| `provId` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:809 - -___ - -### WasAssociatedWithArgs - -Ƭ **WasAssociatedWithArgs**<`K`\>: { [Property in keyof Pick]: WasAssociatedWithFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`WasAssociatedWithResult`](subgraphs.DIDRegistry.md#wasassociatedwithresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:912 - -___ - -### WasAssociatedWithFields - -Ƭ **WasAssociatedWithFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_activityId` | ``true`` | -| `_agentId` | ``true`` | -| `_attributes` | ``true`` | -| `_blockNumberUpdated` | ``true`` | -| `_entityDid` | ``true`` | -| `id` | ``true`` | -| `provId` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:903 - -___ - -### WasAssociatedWithFilter - -Ƭ **WasAssociatedWithFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_activityId?` | `string` \| ``null`` | -| `_activityId_contains?` | `string` \| ``null`` | -| `_activityId_in?` | `string`[] | -| `_activityId_not?` | `string` \| ``null`` | -| `_activityId_not_contains?` | `string` \| ``null`` | -| `_activityId_not_in?` | `string`[] | -| `_agentId?` | `string` \| ``null`` | -| `_agentId_contains?` | `string` \| ``null`` | -| `_agentId_in?` | `string`[] | -| `_agentId_not?` | `string` \| ``null`` | -| `_agentId_not_contains?` | `string` \| ``null`` | -| `_agentId_not_in?` | `string`[] | -| `_attributes?` | `string` \| ``null`` | -| `_attributes_contains?` | `string` \| ``null`` | -| `_attributes_contains_nocase?` | `string` \| ``null`` | -| `_attributes_ends_with?` | `string` \| ``null`` | -| `_attributes_ends_with_nocase?` | `string` \| ``null`` | -| `_attributes_gt?` | `string` \| ``null`` | -| `_attributes_gte?` | `string` \| ``null`` | -| `_attributes_in?` | `string`[] | -| `_attributes_lt?` | `string` \| ``null`` | -| `_attributes_lte?` | `string` \| ``null`` | -| `_attributes_not?` | `string` \| ``null`` | -| `_attributes_not_contains?` | `string` \| ``null`` | -| `_attributes_not_contains_nocase?` | `string` \| ``null`` | -| `_attributes_not_ends_with?` | `string` \| ``null`` | -| `_attributes_not_ends_with_nocase?` | `string` \| ``null`` | -| `_attributes_not_in?` | `string`[] | -| `_attributes_not_starts_with?` | `string` \| ``null`` | -| `_attributes_not_starts_with_nocase?` | `string` \| ``null`` | -| `_attributes_starts_with?` | `string` \| ``null`` | -| `_attributes_starts_with_nocase?` | `string` \| ``null`` | -| `_blockNumberUpdated?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_gt?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_gte?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_in?` | `WeiSource`[] | -| `_blockNumberUpdated_lt?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_lte?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_not?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_not_in?` | `WeiSource`[] | -| `_entityDid?` | `string` \| ``null`` | -| `_entityDid_contains?` | `string` \| ``null`` | -| `_entityDid_in?` | `string`[] | -| `_entityDid_not?` | `string` \| ``null`` | -| `_entityDid_not_contains?` | `string` \| ``null`` | -| `_entityDid_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `provId?` | `string` \| ``null`` | -| `provId_contains?` | `string` \| ``null`` | -| `provId_in?` | `string`[] | -| `provId_not?` | `string` \| ``null`` | -| `provId_not_contains?` | `string` \| ``null`` | -| `provId_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:832 - -___ - -### WasAssociatedWithResult - -Ƭ **WasAssociatedWithResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_activityId` | `string` | -| `_agentId` | `string` | -| `_attributes` | `string` | -| `_blockNumberUpdated` | `Wei` | -| `_entityDid` | `string` | -| `id` | `string` | -| `provId` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:894 - -___ - -### WasDerivedFromArgs - -Ƭ **WasDerivedFromArgs**<`K`\>: { [Property in keyof Pick]: WasDerivedFromFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`WasDerivedFromResult`](subgraphs.DIDRegistry.md#wasderivedfromresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:1005 - -___ - -### WasDerivedFromFields - -Ƭ **WasDerivedFromFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_activityId` | ``true`` | -| `_agentId` | ``true`` | -| `_attributes` | ``true`` | -| `_blockNumberUpdated` | ``true`` | -| `_newEntityDid` | ``true`` | -| `_usedEntityDid` | ``true`` | -| `id` | ``true`` | -| `provId` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:995 - -___ - -### WasDerivedFromFilter - -Ƭ **WasDerivedFromFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_activityId?` | `string` \| ``null`` | -| `_activityId_contains?` | `string` \| ``null`` | -| `_activityId_in?` | `string`[] | -| `_activityId_not?` | `string` \| ``null`` | -| `_activityId_not_contains?` | `string` \| ``null`` | -| `_activityId_not_in?` | `string`[] | -| `_agentId?` | `string` \| ``null`` | -| `_agentId_contains?` | `string` \| ``null`` | -| `_agentId_in?` | `string`[] | -| `_agentId_not?` | `string` \| ``null`` | -| `_agentId_not_contains?` | `string` \| ``null`` | -| `_agentId_not_in?` | `string`[] | -| `_attributes?` | `string` \| ``null`` | -| `_attributes_contains?` | `string` \| ``null`` | -| `_attributes_contains_nocase?` | `string` \| ``null`` | -| `_attributes_ends_with?` | `string` \| ``null`` | -| `_attributes_ends_with_nocase?` | `string` \| ``null`` | -| `_attributes_gt?` | `string` \| ``null`` | -| `_attributes_gte?` | `string` \| ``null`` | -| `_attributes_in?` | `string`[] | -| `_attributes_lt?` | `string` \| ``null`` | -| `_attributes_lte?` | `string` \| ``null`` | -| `_attributes_not?` | `string` \| ``null`` | -| `_attributes_not_contains?` | `string` \| ``null`` | -| `_attributes_not_contains_nocase?` | `string` \| ``null`` | -| `_attributes_not_ends_with?` | `string` \| ``null`` | -| `_attributes_not_ends_with_nocase?` | `string` \| ``null`` | -| `_attributes_not_in?` | `string`[] | -| `_attributes_not_starts_with?` | `string` \| ``null`` | -| `_attributes_not_starts_with_nocase?` | `string` \| ``null`` | -| `_attributes_starts_with?` | `string` \| ``null`` | -| `_attributes_starts_with_nocase?` | `string` \| ``null`` | -| `_blockNumberUpdated?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_gt?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_gte?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_in?` | `WeiSource`[] | -| `_blockNumberUpdated_lt?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_lte?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_not?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_not_in?` | `WeiSource`[] | -| `_newEntityDid?` | `string` \| ``null`` | -| `_newEntityDid_contains?` | `string` \| ``null`` | -| `_newEntityDid_in?` | `string`[] | -| `_newEntityDid_not?` | `string` \| ``null`` | -| `_newEntityDid_not_contains?` | `string` \| ``null`` | -| `_newEntityDid_not_in?` | `string`[] | -| `_usedEntityDid?` | `string` \| ``null`` | -| `_usedEntityDid_contains?` | `string` \| ``null`` | -| `_usedEntityDid_in?` | `string`[] | -| `_usedEntityDid_not?` | `string` \| ``null`` | -| `_usedEntityDid_not_contains?` | `string` \| ``null`` | -| `_usedEntityDid_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `provId?` | `string` \| ``null`` | -| `provId_contains?` | `string` \| ``null`` | -| `provId_in?` | `string`[] | -| `provId_not?` | `string` \| ``null`` | -| `provId_not_contains?` | `string` \| ``null`` | -| `provId_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:917 - -___ - -### WasDerivedFromResult - -Ƭ **WasDerivedFromResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_activityId` | `string` | -| `_agentId` | `string` | -| `_attributes` | `string` | -| `_blockNumberUpdated` | `Wei` | -| `_newEntityDid` | `string` | -| `_usedEntityDid` | `string` | -| `id` | `string` | -| `provId` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:985 - -___ - -### WasGeneratedByArgs - -Ƭ **WasGeneratedByArgs**<`K`\>: { [Property in keyof Pick]: WasGeneratedByFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`WasGeneratedByResult`](subgraphs.DIDRegistry.md#wasgeneratedbyresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:1090 - -___ - -### WasGeneratedByFields - -Ƭ **WasGeneratedByFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_activityId` | ``true`` | -| `_agentId` | ``true`` | -| `_attributes` | ``true`` | -| `_blockNumberUpdated` | ``true`` | -| `_did` | ``true`` | -| `id` | ``true`` | -| `provId` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:1081 - -___ - -### WasGeneratedByFilter - -Ƭ **WasGeneratedByFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_activityId?` | `string` \| ``null`` | -| `_activityId_contains?` | `string` \| ``null`` | -| `_activityId_in?` | `string`[] | -| `_activityId_not?` | `string` \| ``null`` | -| `_activityId_not_contains?` | `string` \| ``null`` | -| `_activityId_not_in?` | `string`[] | -| `_agentId?` | `string` \| ``null`` | -| `_agentId_contains?` | `string` \| ``null`` | -| `_agentId_in?` | `string`[] | -| `_agentId_not?` | `string` \| ``null`` | -| `_agentId_not_contains?` | `string` \| ``null`` | -| `_agentId_not_in?` | `string`[] | -| `_attributes?` | `string` \| ``null`` | -| `_attributes_contains?` | `string` \| ``null`` | -| `_attributes_contains_nocase?` | `string` \| ``null`` | -| `_attributes_ends_with?` | `string` \| ``null`` | -| `_attributes_ends_with_nocase?` | `string` \| ``null`` | -| `_attributes_gt?` | `string` \| ``null`` | -| `_attributes_gte?` | `string` \| ``null`` | -| `_attributes_in?` | `string`[] | -| `_attributes_lt?` | `string` \| ``null`` | -| `_attributes_lte?` | `string` \| ``null`` | -| `_attributes_not?` | `string` \| ``null`` | -| `_attributes_not_contains?` | `string` \| ``null`` | -| `_attributes_not_contains_nocase?` | `string` \| ``null`` | -| `_attributes_not_ends_with?` | `string` \| ``null`` | -| `_attributes_not_ends_with_nocase?` | `string` \| ``null`` | -| `_attributes_not_in?` | `string`[] | -| `_attributes_not_starts_with?` | `string` \| ``null`` | -| `_attributes_not_starts_with_nocase?` | `string` \| ``null`` | -| `_attributes_starts_with?` | `string` \| ``null`` | -| `_attributes_starts_with_nocase?` | `string` \| ``null`` | -| `_blockNumberUpdated?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_gt?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_gte?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_in?` | `WeiSource`[] | -| `_blockNumberUpdated_lt?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_lte?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_not?` | `WeiSource` \| ``null`` | -| `_blockNumberUpdated_not_in?` | `WeiSource`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `provId?` | `string` \| ``null`` | -| `provId_contains?` | `string` \| ``null`` | -| `provId_in?` | `string`[] | -| `provId_not?` | `string` \| ``null`` | -| `provId_not_contains?` | `string` \| ``null`` | -| `provId_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:1010 - -___ - -### WasGeneratedByResult - -Ƭ **WasGeneratedByResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_activityId` | `string` | -| `_agentId` | `string` | -| `_attributes` | `string` | -| `_blockNumberUpdated` | `Wei` | -| `_did` | `string` | -| `id` | `string` | -| `provId` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:1072 - -## Functions - -### getActedOnBehalfById - -▸ **getActedOnBehalfById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ActedOnBehalfResult`](subgraphs.DIDRegistry.md#actedonbehalfresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ActedOnBehalfResult`](subgraphs.DIDRegistry.md#actedonbehalfresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`ActedOnBehalfArgs`](subgraphs.DIDRegistry.md#actedonbehalfargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ActedOnBehalfResult`](subgraphs.DIDRegistry.md#actedonbehalfresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:112 - -___ - -### getActedOnBehalfs - -▸ **getActedOnBehalfs**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ActedOnBehalfResult`](subgraphs.DIDRegistry.md#actedonbehalfresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ActedOnBehalfResult`](subgraphs.DIDRegistry.md#actedonbehalfresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`ActedOnBehalfFilter`](subgraphs.DIDRegistry.md#actedonbehalffilter), [`ActedOnBehalfResult`](subgraphs.DIDRegistry.md#actedonbehalfresult)\> | -| `args` | [`ActedOnBehalfArgs`](subgraphs.DIDRegistry.md#actedonbehalfargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ActedOnBehalfResult`](subgraphs.DIDRegistry.md#actedonbehalfresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:113 - -___ - -### getDIDAttributeRegisteredById - -▸ **getDIDAttributeRegisteredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDAttributeRegisteredResult`](subgraphs.DIDRegistry.md#didattributeregisteredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDAttributeRegisteredResult`](subgraphs.DIDRegistry.md#didattributeregisteredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDAttributeRegisteredArgs`](subgraphs.DIDRegistry.md#didattributeregisteredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDAttributeRegisteredResult`](subgraphs.DIDRegistry.md#didattributeregisteredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:197 - -___ - -### getDIDAttributeRegistereds - -▸ **getDIDAttributeRegistereds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDAttributeRegisteredResult`](subgraphs.DIDRegistry.md#didattributeregisteredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDAttributeRegisteredResult`](subgraphs.DIDRegistry.md#didattributeregisteredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDAttributeRegisteredFilter`](subgraphs.DIDRegistry.md#didattributeregisteredfilter), [`DIDAttributeRegisteredResult`](subgraphs.DIDRegistry.md#didattributeregisteredresult)\> | -| `args` | [`DIDAttributeRegisteredArgs`](subgraphs.DIDRegistry.md#didattributeregisteredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDAttributeRegisteredResult`](subgraphs.DIDRegistry.md#didattributeregisteredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:198 - -___ - -### getDIDOwnershipTransferredById - -▸ **getDIDOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDOwnershipTransferredResult`](subgraphs.DIDRegistry.md#didownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDOwnershipTransferredResult`](subgraphs.DIDRegistry.md#didownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDOwnershipTransferredArgs`](subgraphs.DIDRegistry.md#didownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDOwnershipTransferredResult`](subgraphs.DIDRegistry.md#didownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:242 - -___ - -### getDIDOwnershipTransferreds - -▸ **getDIDOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDOwnershipTransferredResult`](subgraphs.DIDRegistry.md#didownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDOwnershipTransferredResult`](subgraphs.DIDRegistry.md#didownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDOwnershipTransferredFilter`](subgraphs.DIDRegistry.md#didownershiptransferredfilter), [`DIDOwnershipTransferredResult`](subgraphs.DIDRegistry.md#didownershiptransferredresult)\> | -| `args` | [`DIDOwnershipTransferredArgs`](subgraphs.DIDRegistry.md#didownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDOwnershipTransferredResult`](subgraphs.DIDRegistry.md#didownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:243 - -___ - -### getDIDPermissionGrantedById - -▸ **getDIDPermissionGrantedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDPermissionGrantedResult`](subgraphs.DIDRegistry.md#didpermissiongrantedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDPermissionGrantedResult`](subgraphs.DIDRegistry.md#didpermissiongrantedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDPermissionGrantedArgs`](subgraphs.DIDRegistry.md#didpermissiongrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDPermissionGrantedResult`](subgraphs.DIDRegistry.md#didpermissiongrantedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:287 - -___ - -### getDIDPermissionGranteds - -▸ **getDIDPermissionGranteds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDPermissionGrantedResult`](subgraphs.DIDRegistry.md#didpermissiongrantedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDPermissionGrantedResult`](subgraphs.DIDRegistry.md#didpermissiongrantedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDPermissionGrantedFilter`](subgraphs.DIDRegistry.md#didpermissiongrantedfilter), [`DIDPermissionGrantedResult`](subgraphs.DIDRegistry.md#didpermissiongrantedresult)\> | -| `args` | [`DIDPermissionGrantedArgs`](subgraphs.DIDRegistry.md#didpermissiongrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDPermissionGrantedResult`](subgraphs.DIDRegistry.md#didpermissiongrantedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:288 - -___ - -### getDIDPermissionRevokedById - -▸ **getDIDPermissionRevokedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDPermissionRevokedResult`](subgraphs.DIDRegistry.md#didpermissionrevokedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDPermissionRevokedResult`](subgraphs.DIDRegistry.md#didpermissionrevokedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDPermissionRevokedArgs`](subgraphs.DIDRegistry.md#didpermissionrevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDPermissionRevokedResult`](subgraphs.DIDRegistry.md#didpermissionrevokedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:332 - -___ - -### getDIDPermissionRevokeds - -▸ **getDIDPermissionRevokeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDPermissionRevokedResult`](subgraphs.DIDRegistry.md#didpermissionrevokedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDPermissionRevokedResult`](subgraphs.DIDRegistry.md#didpermissionrevokedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDPermissionRevokedFilter`](subgraphs.DIDRegistry.md#didpermissionrevokedfilter), [`DIDPermissionRevokedResult`](subgraphs.DIDRegistry.md#didpermissionrevokedresult)\> | -| `args` | [`DIDPermissionRevokedArgs`](subgraphs.DIDRegistry.md#didpermissionrevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDPermissionRevokedResult`](subgraphs.DIDRegistry.md#didpermissionrevokedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:333 - -___ - -### getDIDProvenanceDelegateAddedById - -▸ **getDIDProvenanceDelegateAddedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDProvenanceDelegateAddedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDProvenanceDelegateAddedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDProvenanceDelegateAddedArgs`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDProvenanceDelegateAddedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:369 - -___ - -### getDIDProvenanceDelegateAddeds - -▸ **getDIDProvenanceDelegateAddeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDProvenanceDelegateAddedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDProvenanceDelegateAddedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDProvenanceDelegateAddedFilter`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedfilter), [`DIDProvenanceDelegateAddedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedresult)\> | -| `args` | [`DIDProvenanceDelegateAddedArgs`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDProvenanceDelegateAddedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:370 - -___ - -### getDIDProvenanceDelegateRemovedById - -▸ **getDIDProvenanceDelegateRemovedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDProvenanceDelegateRemovedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDProvenanceDelegateRemovedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDProvenanceDelegateRemovedArgs`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDProvenanceDelegateRemovedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:412 - -___ - -### getDIDProvenanceDelegateRemoveds - -▸ **getDIDProvenanceDelegateRemoveds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDProvenanceDelegateRemovedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDProvenanceDelegateRemovedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDProvenanceDelegateRemovedFilter`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedfilter), [`DIDProvenanceDelegateRemovedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedresult)\> | -| `args` | [`DIDProvenanceDelegateRemovedArgs`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDProvenanceDelegateRemovedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:413 - -___ - -### getDIDProviderAddedById - -▸ **getDIDProviderAddedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDProviderAddedResult`](subgraphs.DIDRegistry.md#didprovideraddedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDProviderAddedResult`](subgraphs.DIDRegistry.md#didprovideraddedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDProviderAddedArgs`](subgraphs.DIDRegistry.md#didprovideraddedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDProviderAddedResult`](subgraphs.DIDRegistry.md#didprovideraddedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:449 - -___ - -### getDIDProviderAddeds - -▸ **getDIDProviderAddeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDProviderAddedResult`](subgraphs.DIDRegistry.md#didprovideraddedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDProviderAddedResult`](subgraphs.DIDRegistry.md#didprovideraddedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDProviderAddedFilter`](subgraphs.DIDRegistry.md#didprovideraddedfilter), [`DIDProviderAddedResult`](subgraphs.DIDRegistry.md#didprovideraddedresult)\> | -| `args` | [`DIDProviderAddedArgs`](subgraphs.DIDRegistry.md#didprovideraddedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDProviderAddedResult`](subgraphs.DIDRegistry.md#didprovideraddedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:450 - -___ - -### getDIDProviderRemovedById - -▸ **getDIDProviderRemovedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDProviderRemovedResult`](subgraphs.DIDRegistry.md#didproviderremovedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDProviderRemovedResult`](subgraphs.DIDRegistry.md#didproviderremovedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDProviderRemovedArgs`](subgraphs.DIDRegistry.md#didproviderremovedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDProviderRemovedResult`](subgraphs.DIDRegistry.md#didproviderremovedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:492 - -___ - -### getDIDProviderRemoveds - -▸ **getDIDProviderRemoveds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDProviderRemovedResult`](subgraphs.DIDRegistry.md#didproviderremovedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDProviderRemovedResult`](subgraphs.DIDRegistry.md#didproviderremovedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDProviderRemovedFilter`](subgraphs.DIDRegistry.md#didproviderremovedfilter), [`DIDProviderRemovedResult`](subgraphs.DIDRegistry.md#didproviderremovedresult)\> | -| `args` | [`DIDProviderRemovedArgs`](subgraphs.DIDRegistry.md#didproviderremovedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDProviderRemovedResult`](subgraphs.DIDRegistry.md#didproviderremovedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:493 - -___ - -### getDIDRoyaltiesAddedById - -▸ **getDIDRoyaltiesAddedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDRoyaltiesAddedResult`](subgraphs.DIDRegistry.md#didroyaltiesaddedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDRoyaltiesAddedResult`](subgraphs.DIDRegistry.md#didroyaltiesaddedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDRoyaltiesAddedArgs`](subgraphs.DIDRegistry.md#didroyaltiesaddedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDRoyaltiesAddedResult`](subgraphs.DIDRegistry.md#didroyaltiesaddedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:529 - -___ - -### getDIDRoyaltiesAddeds - -▸ **getDIDRoyaltiesAddeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDRoyaltiesAddedResult`](subgraphs.DIDRegistry.md#didroyaltiesaddedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDRoyaltiesAddedResult`](subgraphs.DIDRegistry.md#didroyaltiesaddedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDRoyaltiesAddedFilter`](subgraphs.DIDRegistry.md#didroyaltiesaddedfilter), [`DIDRoyaltiesAddedResult`](subgraphs.DIDRegistry.md#didroyaltiesaddedresult)\> | -| `args` | [`DIDRoyaltiesAddedArgs`](subgraphs.DIDRegistry.md#didroyaltiesaddedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDRoyaltiesAddedResult`](subgraphs.DIDRegistry.md#didroyaltiesaddedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:530 - -___ - -### getDIDRoyaltyRecipientChangedById - -▸ **getDIDRoyaltyRecipientChangedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDRoyaltyRecipientChangedResult`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDRoyaltyRecipientChangedResult`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDRoyaltyRecipientChangedArgs`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDRoyaltyRecipientChangedResult`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:566 - -___ - -### getDIDRoyaltyRecipientChangeds - -▸ **getDIDRoyaltyRecipientChangeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDRoyaltyRecipientChangedResult`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`DIDRoyaltyRecipientChangedResult`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDRoyaltyRecipientChangedFilter`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedfilter), [`DIDRoyaltyRecipientChangedResult`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedresult)\> | -| `args` | [`DIDRoyaltyRecipientChangedArgs`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDRoyaltyRecipientChangedResult`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:567 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.DIDRegistry.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.DIDRegistry.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.DIDRegistry.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.DIDRegistry.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:597 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.DIDRegistry.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.DIDRegistry.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.DIDRegistry.md#initializedfilter), [`InitializedResult`](subgraphs.DIDRegistry.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.DIDRegistry.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.DIDRegistry.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:598 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DIDRegistry.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.DIDRegistry.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.DIDRegistry.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DIDRegistry.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:634 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DIDRegistry.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.DIDRegistry.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.DIDRegistry.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.DIDRegistry.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.DIDRegistry.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DIDRegistry.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:635 - -___ - -### getProvenanceAttributeRegisteredById - -▸ **getProvenanceAttributeRegisteredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ProvenanceAttributeRegisteredResult`](subgraphs.DIDRegistry.md#provenanceattributeregisteredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ProvenanceAttributeRegisteredResult`](subgraphs.DIDRegistry.md#provenanceattributeregisteredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`ProvenanceAttributeRegisteredArgs`](subgraphs.DIDRegistry.md#provenanceattributeregisteredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ProvenanceAttributeRegisteredResult`](subgraphs.DIDRegistry.md#provenanceattributeregisteredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:745 - -___ - -### getProvenanceAttributeRegistereds - -▸ **getProvenanceAttributeRegistereds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ProvenanceAttributeRegisteredResult`](subgraphs.DIDRegistry.md#provenanceattributeregisteredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ProvenanceAttributeRegisteredResult`](subgraphs.DIDRegistry.md#provenanceattributeregisteredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`ProvenanceAttributeRegisteredFilter`](subgraphs.DIDRegistry.md#provenanceattributeregisteredfilter), [`ProvenanceAttributeRegisteredResult`](subgraphs.DIDRegistry.md#provenanceattributeregisteredresult)\> | -| `args` | [`ProvenanceAttributeRegisteredArgs`](subgraphs.DIDRegistry.md#provenanceattributeregisteredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ProvenanceAttributeRegisteredResult`](subgraphs.DIDRegistry.md#provenanceattributeregisteredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:746 - -___ - -### getUsedById - -▸ **getUsedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`UsedResult`](subgraphs.DIDRegistry.md#usedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`UsedResult`](subgraphs.DIDRegistry.md#usedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`UsedArgs`](subgraphs.DIDRegistry.md#usedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`UsedResult`](subgraphs.DIDRegistry.md#usedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:830 - -___ - -### getUseds - -▸ **getUseds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`UsedResult`](subgraphs.DIDRegistry.md#usedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`UsedResult`](subgraphs.DIDRegistry.md#usedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`UsedFilter`](subgraphs.DIDRegistry.md#usedfilter), [`UsedResult`](subgraphs.DIDRegistry.md#usedresult)\> | -| `args` | [`UsedArgs`](subgraphs.DIDRegistry.md#usedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`UsedResult`](subgraphs.DIDRegistry.md#usedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:831 - -___ - -### getWasAssociatedWithById - -▸ **getWasAssociatedWithById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`WasAssociatedWithResult`](subgraphs.DIDRegistry.md#wasassociatedwithresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`WasAssociatedWithResult`](subgraphs.DIDRegistry.md#wasassociatedwithresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`WasAssociatedWithArgs`](subgraphs.DIDRegistry.md#wasassociatedwithargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`WasAssociatedWithResult`](subgraphs.DIDRegistry.md#wasassociatedwithresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:915 - -___ - -### getWasAssociatedWiths - -▸ **getWasAssociatedWiths**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`WasAssociatedWithResult`](subgraphs.DIDRegistry.md#wasassociatedwithresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`WasAssociatedWithResult`](subgraphs.DIDRegistry.md#wasassociatedwithresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`WasAssociatedWithFilter`](subgraphs.DIDRegistry.md#wasassociatedwithfilter), [`WasAssociatedWithResult`](subgraphs.DIDRegistry.md#wasassociatedwithresult)\> | -| `args` | [`WasAssociatedWithArgs`](subgraphs.DIDRegistry.md#wasassociatedwithargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`WasAssociatedWithResult`](subgraphs.DIDRegistry.md#wasassociatedwithresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:916 - -___ - -### getWasDerivedFromById - -▸ **getWasDerivedFromById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`WasDerivedFromResult`](subgraphs.DIDRegistry.md#wasderivedfromresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`WasDerivedFromResult`](subgraphs.DIDRegistry.md#wasderivedfromresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`WasDerivedFromArgs`](subgraphs.DIDRegistry.md#wasderivedfromargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`WasDerivedFromResult`](subgraphs.DIDRegistry.md#wasderivedfromresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:1008 - -___ - -### getWasDerivedFroms - -▸ **getWasDerivedFroms**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`WasDerivedFromResult`](subgraphs.DIDRegistry.md#wasderivedfromresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`WasDerivedFromResult`](subgraphs.DIDRegistry.md#wasderivedfromresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`WasDerivedFromFilter`](subgraphs.DIDRegistry.md#wasderivedfromfilter), [`WasDerivedFromResult`](subgraphs.DIDRegistry.md#wasderivedfromresult)\> | -| `args` | [`WasDerivedFromArgs`](subgraphs.DIDRegistry.md#wasderivedfromargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`WasDerivedFromResult`](subgraphs.DIDRegistry.md#wasderivedfromresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:1009 - -___ - -### getWasGeneratedByById - -▸ **getWasGeneratedByById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`WasGeneratedByResult`](subgraphs.DIDRegistry.md#wasgeneratedbyresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`WasGeneratedByResult`](subgraphs.DIDRegistry.md#wasgeneratedbyresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`WasGeneratedByArgs`](subgraphs.DIDRegistry.md#wasgeneratedbyargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`WasGeneratedByResult`](subgraphs.DIDRegistry.md#wasgeneratedbyresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:1093 - -___ - -### getWasGeneratedBys - -▸ **getWasGeneratedBys**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`WasGeneratedByResult`](subgraphs.DIDRegistry.md#wasgeneratedbyresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`WasGeneratedByResult`](subgraphs.DIDRegistry.md#wasgeneratedbyresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`WasGeneratedByFilter`](subgraphs.DIDRegistry.md#wasgeneratedbyfilter), [`WasGeneratedByResult`](subgraphs.DIDRegistry.md#wasgeneratedbyresult)\> | -| `args` | [`WasGeneratedByArgs`](subgraphs.DIDRegistry.md#wasgeneratedbyargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`WasGeneratedByResult`](subgraphs.DIDRegistry.md#wasgeneratedbyresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:1094 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.DIDSalesTemplate.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.DIDSalesTemplate.md deleted file mode 100644 index 20fc209882..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.DIDSalesTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / DIDSalesTemplate - -# Namespace: DIDSalesTemplate - -[subgraphs](subgraphs.md).DIDSalesTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.DIDSalesTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.DIDSalesTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.DIDSalesTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.DIDSalesTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.DIDSalesTemplate.md#initializedargs) -- [InitializedFields](subgraphs.DIDSalesTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.DIDSalesTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.DIDSalesTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.DIDSalesTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.DIDSalesTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.DIDSalesTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.DIDSalesTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.DIDSalesTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.DIDSalesTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.DIDSalesTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.DIDSalesTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.DIDSalesTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.DIDSalesTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.DIDSalesTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.DIDSalesTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.DIDSalesTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:117 - -___ - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | ``true`` | -| `_accessProvider` | ``true`` | -| `_agreementId` | ``true`` | -| `_conditionIdSeeds` | ``true`` | -| `_conditionIds` | ``true`` | -| `_creator` | ``true`` | -| `_did` | ``true`` | -| `_idSeed` | ``true`` | -| `_timeLocks` | ``true`` | -| `_timeOuts` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:104 - -___ - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer?` | `string` \| ``null`` | -| `_accessConsumer_contains?` | `string` \| ``null`` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| ``null`` | -| `_accessConsumer_not_contains?` | `string` \| ``null`` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| ``null`` | -| `_accessProvider_contains?` | `string` \| ``null`` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| ``null`` | -| `_accessProvider_not_contains?` | `string` \| ``null`` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| ``null`` | -| `_creator_contains?` | `string` \| ``null`` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| ``null`` | -| `_creator_not_contains?` | `string` \| ``null`` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| ``null`` | -| `_idSeed_contains?` | `string` \| ``null`` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| ``null`` | -| `_idSeed_not_contains?` | `string` \| ``null`` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:21 - -___ - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| ``null``)[] | -| `_conditionIds` | (`string` \| ``null``)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| ``null``)[] | -| `_timeOuts` | (`Wei` \| ``null``)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:91 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.DIDSalesTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:148 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:144 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:122 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:140 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.DIDSalesTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:185 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:180 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:153 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:175 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.DIDSalesTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.DIDSalesTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDSalesTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.DIDSalesTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.DIDSalesTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:120 - -___ - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.DIDSalesTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.DIDSalesTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDSalesTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.DIDSalesTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.DIDSalesTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.DIDSalesTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.DIDSalesTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:121 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.DIDSalesTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.DIDSalesTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDSalesTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.DIDSalesTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.DIDSalesTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:151 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.DIDSalesTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.DIDSalesTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDSalesTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.DIDSalesTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.DIDSalesTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.DIDSalesTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.DIDSalesTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:152 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DIDSalesTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.DIDSalesTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDSalesTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.DIDSalesTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DIDSalesTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:188 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DIDSalesTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.DIDSalesTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDSalesTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.DIDSalesTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.DIDSalesTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.DIDSalesTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DIDSalesTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:189 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.Dispenser.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.Dispenser.md deleted file mode 100644 index 31605737c5..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.Dispenser.md +++ /dev/null @@ -1,663 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / Dispenser - -# Namespace: Dispenser - -[subgraphs](subgraphs.md).Dispenser - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.Dispenser.md#initializedargs) -- [InitializedFields](subgraphs.Dispenser.md#initializedfields) -- [InitializedFilter](subgraphs.Dispenser.md#initializedfilter) -- [InitializedResult](subgraphs.Dispenser.md#initializedresult) -- [MultiQueryOptions](subgraphs.Dispenser.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.Dispenser.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.Dispenser.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.Dispenser.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.Dispenser.md#ownershiptransferredresult) -- [RequestFrequencyExceededArgs](subgraphs.Dispenser.md#requestfrequencyexceededargs) -- [RequestFrequencyExceededFields](subgraphs.Dispenser.md#requestfrequencyexceededfields) -- [RequestFrequencyExceededFilter](subgraphs.Dispenser.md#requestfrequencyexceededfilter) -- [RequestFrequencyExceededResult](subgraphs.Dispenser.md#requestfrequencyexceededresult) -- [RequestLimitExceededArgs](subgraphs.Dispenser.md#requestlimitexceededargs) -- [RequestLimitExceededFields](subgraphs.Dispenser.md#requestlimitexceededfields) -- [RequestLimitExceededFilter](subgraphs.Dispenser.md#requestlimitexceededfilter) -- [RequestLimitExceededResult](subgraphs.Dispenser.md#requestlimitexceededresult) -- [SingleQueryOptions](subgraphs.Dispenser.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.Dispenser.md#getinitializedbyid) -- [getInitializeds](subgraphs.Dispenser.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.Dispenser.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.Dispenser.md#getownershiptransferreds) -- [getRequestFrequencyExceededById](subgraphs.Dispenser.md#getrequestfrequencyexceededbyid) -- [getRequestFrequencyExceededs](subgraphs.Dispenser.md#getrequestfrequencyexceededs) -- [getRequestLimitExceededById](subgraphs.Dispenser.md#getrequestlimitexceededbyid) -- [getRequestLimitExceededs](subgraphs.Dispenser.md#getrequestlimitexceededs) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.Dispenser.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:47 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:43 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:21 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:39 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.Dispenser.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:84 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:79 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:52 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:74 - -___ - -### RequestFrequencyExceededArgs - -Ƭ **RequestFrequencyExceededArgs**<`K`\>: { [Property in keyof Pick]: RequestFrequencyExceededFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RequestFrequencyExceededResult`](subgraphs.Dispenser.md#requestfrequencyexceededresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:123 - -___ - -### RequestFrequencyExceededFields - -Ƭ **RequestFrequencyExceededFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `minPeriod` | ``true`` | -| `requester` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:118 - -___ - -### RequestFrequencyExceededFilter - -Ƭ **RequestFrequencyExceededFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `minPeriod?` | `WeiSource` \| ``null`` | -| `minPeriod_gt?` | `WeiSource` \| ``null`` | -| `minPeriod_gte?` | `WeiSource` \| ``null`` | -| `minPeriod_in?` | `WeiSource`[] | -| `minPeriod_lt?` | `WeiSource` \| ``null`` | -| `minPeriod_lte?` | `WeiSource` \| ``null`` | -| `minPeriod_not?` | `WeiSource` \| ``null`` | -| `minPeriod_not_in?` | `WeiSource`[] | -| `requester?` | `string` \| ``null`` | -| `requester_contains?` | `string` \| ``null`` | -| `requester_in?` | `string`[] | -| `requester_not?` | `string` \| ``null`` | -| `requester_not_contains?` | `string` \| ``null`` | -| `requester_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:89 - -___ - -### RequestFrequencyExceededResult - -Ƭ **RequestFrequencyExceededResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `minPeriod` | `Wei` | -| `requester` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:113 - -___ - -### RequestLimitExceededArgs - -Ƭ **RequestLimitExceededArgs**<`K`\>: { [Property in keyof Pick]: RequestLimitExceededFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RequestLimitExceededResult`](subgraphs.Dispenser.md#requestlimitexceededresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:172 - -___ - -### RequestLimitExceededFields - -Ƭ **RequestLimitExceededFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | ``true`` | -| `id` | ``true`` | -| `maxAmount` | ``true`` | -| `requester` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:166 - -___ - -### RequestLimitExceededFilter - -Ƭ **RequestLimitExceededFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount?` | `WeiSource` \| ``null`` | -| `amount_gt?` | `WeiSource` \| ``null`` | -| `amount_gte?` | `WeiSource` \| ``null`` | -| `amount_in?` | `WeiSource`[] | -| `amount_lt?` | `WeiSource` \| ``null`` | -| `amount_lte?` | `WeiSource` \| ``null`` | -| `amount_not?` | `WeiSource` \| ``null`` | -| `amount_not_in?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `maxAmount?` | `WeiSource` \| ``null`` | -| `maxAmount_gt?` | `WeiSource` \| ``null`` | -| `maxAmount_gte?` | `WeiSource` \| ``null`` | -| `maxAmount_in?` | `WeiSource`[] | -| `maxAmount_lt?` | `WeiSource` \| ``null`` | -| `maxAmount_lte?` | `WeiSource` \| ``null`` | -| `maxAmount_not?` | `WeiSource` \| ``null`` | -| `maxAmount_not_in?` | `WeiSource`[] | -| `requester?` | `string` \| ``null`` | -| `requester_contains?` | `string` \| ``null`` | -| `requester_in?` | `string`[] | -| `requester_not?` | `string` \| ``null`` | -| `requester_not_contains?` | `string` \| ``null`` | -| `requester_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:128 - -___ - -### RequestLimitExceededResult - -Ƭ **RequestLimitExceededResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | `Wei` | -| `id` | `string` | -| `maxAmount` | `Wei` | -| `requester` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:160 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:2 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.Dispenser.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.Dispenser.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.Dispenser.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.Dispenser.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.Dispenser.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:50 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.Dispenser.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.Dispenser.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.Dispenser.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.Dispenser.md#initializedfilter), [`InitializedResult`](subgraphs.Dispenser.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.Dispenser.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.Dispenser.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:51 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.Dispenser.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.Dispenser.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.Dispenser.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.Dispenser.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.Dispenser.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:87 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.Dispenser.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.Dispenser.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.Dispenser.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.Dispenser.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.Dispenser.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.Dispenser.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.Dispenser.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:88 - -___ - -### getRequestFrequencyExceededById - -▸ **getRequestFrequencyExceededById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RequestFrequencyExceededResult`](subgraphs.Dispenser.md#requestfrequencyexceededresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RequestFrequencyExceededResult`](subgraphs.Dispenser.md#requestfrequencyexceededresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.Dispenser.md#singlequeryoptions) | -| `args` | [`RequestFrequencyExceededArgs`](subgraphs.Dispenser.md#requestfrequencyexceededargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RequestFrequencyExceededResult`](subgraphs.Dispenser.md#requestfrequencyexceededresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:126 - -___ - -### getRequestFrequencyExceededs - -▸ **getRequestFrequencyExceededs**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RequestFrequencyExceededResult`](subgraphs.Dispenser.md#requestfrequencyexceededresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RequestFrequencyExceededResult`](subgraphs.Dispenser.md#requestfrequencyexceededresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.Dispenser.md#multiqueryoptions)<[`RequestFrequencyExceededFilter`](subgraphs.Dispenser.md#requestfrequencyexceededfilter), [`RequestFrequencyExceededResult`](subgraphs.Dispenser.md#requestfrequencyexceededresult)\> | -| `args` | [`RequestFrequencyExceededArgs`](subgraphs.Dispenser.md#requestfrequencyexceededargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RequestFrequencyExceededResult`](subgraphs.Dispenser.md#requestfrequencyexceededresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:127 - -___ - -### getRequestLimitExceededById - -▸ **getRequestLimitExceededById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RequestLimitExceededResult`](subgraphs.Dispenser.md#requestlimitexceededresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RequestLimitExceededResult`](subgraphs.Dispenser.md#requestlimitexceededresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.Dispenser.md#singlequeryoptions) | -| `args` | [`RequestLimitExceededArgs`](subgraphs.Dispenser.md#requestlimitexceededargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RequestLimitExceededResult`](subgraphs.Dispenser.md#requestlimitexceededresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:175 - -___ - -### getRequestLimitExceededs - -▸ **getRequestLimitExceededs**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RequestLimitExceededResult`](subgraphs.Dispenser.md#requestlimitexceededresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RequestLimitExceededResult`](subgraphs.Dispenser.md#requestlimitexceededresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.Dispenser.md#multiqueryoptions)<[`RequestLimitExceededFilter`](subgraphs.Dispenser.md#requestlimitexceededfilter), [`RequestLimitExceededResult`](subgraphs.Dispenser.md#requestlimitexceededresult)\> | -| `args` | [`RequestLimitExceededArgs`](subgraphs.Dispenser.md#requestlimitexceededargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RequestLimitExceededResult`](subgraphs.Dispenser.md#requestlimitexceededresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:176 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.DistributeNFTCollateralCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.DistributeNFTCollateralCondition.md deleted file mode 100644 index 8561003286..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.DistributeNFTCollateralCondition.md +++ /dev/null @@ -1,381 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / DistributeNFTCollateralCondition - -# Namespace: DistributeNFTCollateralCondition - -[subgraphs](subgraphs.md).DistributeNFTCollateralCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.DistributeNFTCollateralCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.DistributeNFTCollateralCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.DistributeNFTCollateralCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.DistributeNFTCollateralCondition.md#fulfilledresult) -- [MultiQueryOptions](subgraphs.DistributeNFTCollateralCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.DistributeNFTCollateralCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.DistributeNFTCollateralCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.DistributeNFTCollateralCondition.md#getfulfilleds) -- [getOwnershipTransferredById](subgraphs.DistributeNFTCollateralCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.DistributeNFTCollateralCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:76 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | ``true`` | -| `_conditionId` | ``true`` | -| `_contract` | ``true`` | -| `_did` | ``true`` | -| `_receiver` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:68 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_contract?` | `string` \| ``null`` | -| `_contract_contains?` | `string` \| ``null`` | -| `_contract_in?` | `string`[] | -| `_contract_not?` | `string` \| ``null`` | -| `_contract_not_contains?` | `string` \| ``null`` | -| `_contract_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_receiver?` | `string` \| ``null`` | -| `_receiver_contains?` | `string` \| ``null`` | -| `_receiver_in?` | `string`[] | -| `_receiver_not?` | `string` \| ``null`` | -| `_receiver_not_contains?` | `string` \| ``null`` | -| `_receiver_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:20 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | `string` | -| `_conditionId` | `string` | -| `_contract` | `string` | -| `_did` | `string` | -| `_receiver` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:60 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:9 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:113 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:108 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:81 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:103 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:1 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DistributeNFTCollateralCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:79 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DistributeNFTCollateralCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:80 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DistributeNFTCollateralCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:116 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DistributeNFTCollateralCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:117 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.EscrowComputeExecutionTemplate.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.EscrowComputeExecutionTemplate.md deleted file mode 100644 index 6b2e1e14f8..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.EscrowComputeExecutionTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / EscrowComputeExecutionTemplate - -# Namespace: EscrowComputeExecutionTemplate - -[subgraphs](subgraphs.md).EscrowComputeExecutionTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.EscrowComputeExecutionTemplate.md#initializedargs) -- [InitializedFields](subgraphs.EscrowComputeExecutionTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.EscrowComputeExecutionTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.EscrowComputeExecutionTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.EscrowComputeExecutionTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.EscrowComputeExecutionTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.EscrowComputeExecutionTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.EscrowComputeExecutionTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.EscrowComputeExecutionTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.EscrowComputeExecutionTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.EscrowComputeExecutionTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.EscrowComputeExecutionTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:117 - -___ - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | ``true`` | -| `_accessProvider` | ``true`` | -| `_agreementId` | ``true`` | -| `_conditionIdSeeds` | ``true`` | -| `_conditionIds` | ``true`` | -| `_creator` | ``true`` | -| `_did` | ``true`` | -| `_idSeed` | ``true`` | -| `_timeLocks` | ``true`` | -| `_timeOuts` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:104 - -___ - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer?` | `string` \| ``null`` | -| `_accessConsumer_contains?` | `string` \| ``null`` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| ``null`` | -| `_accessConsumer_not_contains?` | `string` \| ``null`` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| ``null`` | -| `_accessProvider_contains?` | `string` \| ``null`` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| ``null`` | -| `_accessProvider_not_contains?` | `string` \| ``null`` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| ``null`` | -| `_creator_contains?` | `string` \| ``null`` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| ``null`` | -| `_creator_not_contains?` | `string` \| ``null`` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| ``null`` | -| `_idSeed_contains?` | `string` \| ``null`` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| ``null`` | -| `_idSeed_not_contains?` | `string` \| ``null`` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:21 - -___ - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| ``null``)[] | -| `_conditionIds` | (`string` \| ``null``)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| ``null``)[] | -| `_timeOuts` | (`Wei` \| ``null``)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:91 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.EscrowComputeExecutionTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:148 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:144 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:122 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:140 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:185 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:180 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:153 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:175 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.EscrowComputeExecutionTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:120 - -___ - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.EscrowComputeExecutionTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:121 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.EscrowComputeExecutionTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.EscrowComputeExecutionTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.EscrowComputeExecutionTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.EscrowComputeExecutionTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.EscrowComputeExecutionTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:151 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.EscrowComputeExecutionTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.EscrowComputeExecutionTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.EscrowComputeExecutionTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.EscrowComputeExecutionTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.EscrowComputeExecutionTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.EscrowComputeExecutionTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.EscrowComputeExecutionTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:152 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.EscrowComputeExecutionTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:188 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.EscrowComputeExecutionTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:189 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.EscrowPaymentCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.EscrowPaymentCondition.md deleted file mode 100644 index 4065c9fb0e..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.EscrowPaymentCondition.md +++ /dev/null @@ -1,675 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / EscrowPaymentCondition - -# Namespace: EscrowPaymentCondition - -[subgraphs](subgraphs.md).EscrowPaymentCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.EscrowPaymentCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.EscrowPaymentCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.EscrowPaymentCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.EscrowPaymentCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.EscrowPaymentCondition.md#initializedargs) -- [InitializedFields](subgraphs.EscrowPaymentCondition.md#initializedfields) -- [InitializedFilter](subgraphs.EscrowPaymentCondition.md#initializedfilter) -- [InitializedResult](subgraphs.EscrowPaymentCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.EscrowPaymentCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.EscrowPaymentCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.EscrowPaymentCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.EscrowPaymentCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.EscrowPaymentCondition.md#ownershiptransferredresult) -- [ReceivedArgs](subgraphs.EscrowPaymentCondition.md#receivedargs) -- [ReceivedFields](subgraphs.EscrowPaymentCondition.md#receivedfields) -- [ReceivedFilter](subgraphs.EscrowPaymentCondition.md#receivedfilter) -- [ReceivedResult](subgraphs.EscrowPaymentCondition.md#receivedresult) -- [SingleQueryOptions](subgraphs.EscrowPaymentCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.EscrowPaymentCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.EscrowPaymentCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.EscrowPaymentCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.EscrowPaymentCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.EscrowPaymentCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.EscrowPaymentCondition.md#getownershiptransferreds) -- [getReceivedById](subgraphs.EscrowPaymentCondition.md#getreceivedbyid) -- [getReceiveds](subgraphs.EscrowPaymentCondition.md#getreceiveds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.EscrowPaymentCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:77 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | ``true`` | -| `_amounts` | ``true`` | -| `_conditionId` | ``true`` | -| `_receivers` | ``true`` | -| `_tokenAddress` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:69 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_amounts?` | `WeiSource`[] | -| `_amounts_contains?` | `WeiSource`[] | -| `_amounts_contains_nocase?` | `WeiSource`[] | -| `_amounts_not?` | `WeiSource`[] | -| `_amounts_not_contains?` | `WeiSource`[] | -| `_amounts_not_contains_nocase?` | `WeiSource`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_receivers?` | `string`[] | -| `_receivers_contains?` | `string`[] | -| `_receivers_contains_nocase?` | `string`[] | -| `_receivers_not?` | `string`[] | -| `_receivers_not_contains?` | `string`[] | -| `_receivers_not_contains_nocase?` | `string`[] | -| `_tokenAddress?` | `string` \| ``null`` | -| `_tokenAddress_contains?` | `string` \| ``null`` | -| `_tokenAddress_in?` | `string`[] | -| `_tokenAddress_not?` | `string` \| ``null`` | -| `_tokenAddress_not_contains?` | `string` \| ``null`` | -| `_tokenAddress_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:21 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | `string` | -| `_amounts` | (`Wei` \| ``null``)[] | -| `_conditionId` | `string` | -| `_receivers` | (`string` \| ``null``)[] | -| `_tokenAddress` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:61 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.EscrowPaymentCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:108 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:104 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:82 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:100 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:145 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:140 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:113 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:135 - -___ - -### ReceivedArgs - -Ƭ **ReceivedArgs**<`K`\>: { [Property in keyof Pick]: ReceivedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ReceivedResult`](subgraphs.EscrowPaymentCondition.md#receivedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:184 - -___ - -### ReceivedFields - -Ƭ **ReceivedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_from` | ``true`` | -| `_value` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:179 - -___ - -### ReceivedFilter - -Ƭ **ReceivedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_from?` | `string` \| ``null`` | -| `_from_contains?` | `string` \| ``null`` | -| `_from_in?` | `string`[] | -| `_from_not?` | `string` \| ``null`` | -| `_from_not_contains?` | `string` \| ``null`` | -| `_from_not_in?` | `string`[] | -| `_value?` | `WeiSource` \| ``null`` | -| `_value_gt?` | `WeiSource` \| ``null`` | -| `_value_gte?` | `WeiSource` \| ``null`` | -| `_value_in?` | `WeiSource`[] | -| `_value_lt?` | `WeiSource` \| ``null`` | -| `_value_lte?` | `WeiSource` \| ``null`` | -| `_value_not?` | `WeiSource` \| ``null`` | -| `_value_not_in?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:150 - -___ - -### ReceivedResult - -Ƭ **ReceivedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_from` | `string` | -| `_value` | `Wei` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:174 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.EscrowPaymentCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.EscrowPaymentCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.EscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.EscrowPaymentCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.EscrowPaymentCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:80 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.EscrowPaymentCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.EscrowPaymentCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.EscrowPaymentCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.EscrowPaymentCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.EscrowPaymentCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.EscrowPaymentCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.EscrowPaymentCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:81 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.EscrowPaymentCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.EscrowPaymentCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.EscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.EscrowPaymentCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.EscrowPaymentCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:111 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.EscrowPaymentCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.EscrowPaymentCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.EscrowPaymentCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.EscrowPaymentCondition.md#initializedfilter), [`InitializedResult`](subgraphs.EscrowPaymentCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.EscrowPaymentCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.EscrowPaymentCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:112 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.EscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:148 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.EscrowPaymentCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:149 - -___ - -### getReceivedById - -▸ **getReceivedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ReceivedResult`](subgraphs.EscrowPaymentCondition.md#receivedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ReceivedResult`](subgraphs.EscrowPaymentCondition.md#receivedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.EscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`ReceivedArgs`](subgraphs.EscrowPaymentCondition.md#receivedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ReceivedResult`](subgraphs.EscrowPaymentCondition.md#receivedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:187 - -___ - -### getReceiveds - -▸ **getReceiveds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ReceivedResult`](subgraphs.EscrowPaymentCondition.md#receivedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ReceivedResult`](subgraphs.EscrowPaymentCondition.md#receivedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.EscrowPaymentCondition.md#multiqueryoptions)<[`ReceivedFilter`](subgraphs.EscrowPaymentCondition.md#receivedfilter), [`ReceivedResult`](subgraphs.EscrowPaymentCondition.md#receivedresult)\> | -| `args` | [`ReceivedArgs`](subgraphs.EscrowPaymentCondition.md#receivedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ReceivedResult`](subgraphs.EscrowPaymentCondition.md#receivedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:188 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.HashLockCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.HashLockCondition.md deleted file mode 100644 index d9b544631f..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.HashLockCondition.md +++ /dev/null @@ -1,351 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / HashLockCondition - -# Namespace: HashLockCondition - -[subgraphs](subgraphs.md).HashLockCondition - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.HashLockCondition.md#initializedargs) -- [InitializedFields](subgraphs.HashLockCondition.md#initializedfields) -- [InitializedFilter](subgraphs.HashLockCondition.md#initializedfilter) -- [InitializedResult](subgraphs.HashLockCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.HashLockCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.HashLockCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.HashLockCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.HashLockCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.HashLockCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.HashLockCondition.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.HashLockCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.HashLockCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.HashLockCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.HashLockCondition.md#getownershiptransferreds) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.HashLockCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:46 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:42 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:20 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:38 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:9 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.HashLockCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:83 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:78 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:51 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:73 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:1 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.HashLockCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.HashLockCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.HashLockCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.HashLockCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.HashLockCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:49 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.HashLockCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.HashLockCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.HashLockCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.HashLockCondition.md#initializedfilter), [`InitializedResult`](subgraphs.HashLockCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.HashLockCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.HashLockCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:50 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.HashLockCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.HashLockCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.HashLockCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.HashLockCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.HashLockCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:86 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.HashLockCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.HashLockCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.HashLockCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.HashLockCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.HashLockCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.HashLockCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.HashLockCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:87 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.LockPaymentCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.LockPaymentCondition.md deleted file mode 100644 index 523dc4e35e..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.LockPaymentCondition.md +++ /dev/null @@ -1,1011 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / LockPaymentCondition - -# Namespace: LockPaymentCondition - -[subgraphs](subgraphs.md).LockPaymentCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.LockPaymentCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.LockPaymentCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.LockPaymentCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.LockPaymentCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.LockPaymentCondition.md#initializedargs) -- [InitializedFields](subgraphs.LockPaymentCondition.md#initializedfields) -- [InitializedFilter](subgraphs.LockPaymentCondition.md#initializedfilter) -- [InitializedResult](subgraphs.LockPaymentCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.LockPaymentCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.LockPaymentCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.LockPaymentCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.LockPaymentCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.LockPaymentCondition.md#ownershiptransferredresult) -- [RoleAdminChangedArgs](subgraphs.LockPaymentCondition.md#roleadminchangedargs) -- [RoleAdminChangedFields](subgraphs.LockPaymentCondition.md#roleadminchangedfields) -- [RoleAdminChangedFilter](subgraphs.LockPaymentCondition.md#roleadminchangedfilter) -- [RoleAdminChangedResult](subgraphs.LockPaymentCondition.md#roleadminchangedresult) -- [RoleGrantedArgs](subgraphs.LockPaymentCondition.md#rolegrantedargs) -- [RoleGrantedFields](subgraphs.LockPaymentCondition.md#rolegrantedfields) -- [RoleGrantedFilter](subgraphs.LockPaymentCondition.md#rolegrantedfilter) -- [RoleGrantedResult](subgraphs.LockPaymentCondition.md#rolegrantedresult) -- [RoleRevokedArgs](subgraphs.LockPaymentCondition.md#rolerevokedargs) -- [RoleRevokedFields](subgraphs.LockPaymentCondition.md#rolerevokedfields) -- [RoleRevokedFilter](subgraphs.LockPaymentCondition.md#rolerevokedfilter) -- [RoleRevokedResult](subgraphs.LockPaymentCondition.md#rolerevokedresult) -- [SingleQueryOptions](subgraphs.LockPaymentCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.LockPaymentCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.LockPaymentCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.LockPaymentCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.LockPaymentCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.LockPaymentCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.LockPaymentCondition.md#getownershiptransferreds) -- [getRoleAdminChangedById](subgraphs.LockPaymentCondition.md#getroleadminchangedbyid) -- [getRoleAdminChangeds](subgraphs.LockPaymentCondition.md#getroleadminchangeds) -- [getRoleGrantedById](subgraphs.LockPaymentCondition.md#getrolegrantedbyid) -- [getRoleGranteds](subgraphs.LockPaymentCondition.md#getrolegranteds) -- [getRoleRevokedById](subgraphs.LockPaymentCondition.md#getrolerevokedbyid) -- [getRoleRevokeds](subgraphs.LockPaymentCondition.md#getrolerevokeds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.LockPaymentCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:93 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | ``true`` | -| `_amounts` | ``true`` | -| `_conditionId` | ``true`` | -| `_did` | ``true`` | -| `_receivers` | ``true`` | -| `_rewardAddress` | ``true`` | -| `_tokenAddress` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:83 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_amounts?` | `WeiSource`[] | -| `_amounts_contains?` | `WeiSource`[] | -| `_amounts_contains_nocase?` | `WeiSource`[] | -| `_amounts_not?` | `WeiSource`[] | -| `_amounts_not_contains?` | `WeiSource`[] | -| `_amounts_not_contains_nocase?` | `WeiSource`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_receivers?` | `string`[] | -| `_receivers_contains?` | `string`[] | -| `_receivers_contains_nocase?` | `string`[] | -| `_receivers_not?` | `string`[] | -| `_receivers_not_contains?` | `string`[] | -| `_receivers_not_contains_nocase?` | `string`[] | -| `_rewardAddress?` | `string` \| ``null`` | -| `_rewardAddress_contains?` | `string` \| ``null`` | -| `_rewardAddress_in?` | `string`[] | -| `_rewardAddress_not?` | `string` \| ``null`` | -| `_rewardAddress_not_contains?` | `string` \| ``null`` | -| `_rewardAddress_not_in?` | `string`[] | -| `_tokenAddress?` | `string` \| ``null`` | -| `_tokenAddress_contains?` | `string` \| ``null`` | -| `_tokenAddress_in?` | `string`[] | -| `_tokenAddress_not?` | `string` \| ``null`` | -| `_tokenAddress_not_contains?` | `string` \| ``null`` | -| `_tokenAddress_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:21 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | `string` | -| `_amounts` | (`Wei` \| ``null``)[] | -| `_conditionId` | `string` | -| `_did` | `string` | -| `_receivers` | (`string` \| ``null``)[] | -| `_rewardAddress` | `string` | -| `_tokenAddress` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:73 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.LockPaymentCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:124 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:120 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:98 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:116 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.LockPaymentCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:161 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:156 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:129 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:151 - -___ - -### RoleAdminChangedArgs - -Ƭ **RoleAdminChangedArgs**<`K`\>: { [Property in keyof Pick]: RoleAdminChangedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.LockPaymentCondition.md#roleadminchangedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:206 - -___ - -### RoleAdminChangedFields - -Ƭ **RoleAdminChangedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newAdminRole` | ``true`` | -| `previousAdminRole` | ``true`` | -| `role` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:200 - -___ - -### RoleAdminChangedFilter - -Ƭ **RoleAdminChangedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newAdminRole?` | `string` \| ``null`` | -| `newAdminRole_contains?` | `string` \| ``null`` | -| `newAdminRole_in?` | `string`[] | -| `newAdminRole_not?` | `string` \| ``null`` | -| `newAdminRole_not_contains?` | `string` \| ``null`` | -| `newAdminRole_not_in?` | `string`[] | -| `previousAdminRole?` | `string` \| ``null`` | -| `previousAdminRole_contains?` | `string` \| ``null`` | -| `previousAdminRole_in?` | `string`[] | -| `previousAdminRole_not?` | `string` \| ``null`` | -| `previousAdminRole_not_contains?` | `string` \| ``null`` | -| `previousAdminRole_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:166 - -___ - -### RoleAdminChangedResult - -Ƭ **RoleAdminChangedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newAdminRole` | `string` | -| `previousAdminRole` | `string` | -| `role` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:194 - -___ - -### RoleGrantedArgs - -Ƭ **RoleGrantedArgs**<`K`\>: { [Property in keyof Pick]: RoleGrantedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.LockPaymentCondition.md#rolegrantedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:251 - -___ - -### RoleGrantedFields - -Ƭ **RoleGrantedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | ``true`` | -| `id` | ``true`` | -| `role` | ``true`` | -| `sender` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:245 - -___ - -### RoleGrantedFilter - -Ƭ **RoleGrantedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account?` | `string` \| ``null`` | -| `account_contains?` | `string` \| ``null`` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| ``null`` | -| `account_not_contains?` | `string` \| ``null`` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| ``null`` | -| `sender_contains?` | `string` \| ``null`` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| ``null`` | -| `sender_not_contains?` | `string` \| ``null`` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:211 - -___ - -### RoleGrantedResult - -Ƭ **RoleGrantedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:239 - -___ - -### RoleRevokedArgs - -Ƭ **RoleRevokedArgs**<`K`\>: { [Property in keyof Pick]: RoleRevokedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.LockPaymentCondition.md#rolerevokedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:296 - -___ - -### RoleRevokedFields - -Ƭ **RoleRevokedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | ``true`` | -| `id` | ``true`` | -| `role` | ``true`` | -| `sender` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:290 - -___ - -### RoleRevokedFilter - -Ƭ **RoleRevokedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account?` | `string` \| ``null`` | -| `account_contains?` | `string` \| ``null`` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| ``null`` | -| `account_not_contains?` | `string` \| ``null`` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| ``null`` | -| `sender_contains?` | `string` \| ``null`` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| ``null`` | -| `sender_not_contains?` | `string` \| ``null`` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:256 - -___ - -### RoleRevokedResult - -Ƭ **RoleRevokedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:284 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.LockPaymentCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.LockPaymentCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.LockPaymentCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.LockPaymentCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.LockPaymentCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:96 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.LockPaymentCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.LockPaymentCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.LockPaymentCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.LockPaymentCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.LockPaymentCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.LockPaymentCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.LockPaymentCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:97 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.LockPaymentCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.LockPaymentCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.LockPaymentCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.LockPaymentCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.LockPaymentCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:127 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.LockPaymentCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.LockPaymentCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.LockPaymentCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.LockPaymentCondition.md#initializedfilter), [`InitializedResult`](subgraphs.LockPaymentCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.LockPaymentCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.LockPaymentCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:128 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.LockPaymentCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.LockPaymentCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.LockPaymentCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.LockPaymentCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.LockPaymentCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:164 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.LockPaymentCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.LockPaymentCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.LockPaymentCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.LockPaymentCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.LockPaymentCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.LockPaymentCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.LockPaymentCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:165 - -___ - -### getRoleAdminChangedById - -▸ **getRoleAdminChangedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.LockPaymentCondition.md#roleadminchangedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.LockPaymentCondition.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.LockPaymentCondition.md#singlequeryoptions) | -| `args` | [`RoleAdminChangedArgs`](subgraphs.LockPaymentCondition.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.LockPaymentCondition.md#roleadminchangedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:209 - -___ - -### getRoleAdminChangeds - -▸ **getRoleAdminChangeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.LockPaymentCondition.md#roleadminchangedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.LockPaymentCondition.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.LockPaymentCondition.md#multiqueryoptions)<[`RoleAdminChangedFilter`](subgraphs.LockPaymentCondition.md#roleadminchangedfilter), [`RoleAdminChangedResult`](subgraphs.LockPaymentCondition.md#roleadminchangedresult)\> | -| `args` | [`RoleAdminChangedArgs`](subgraphs.LockPaymentCondition.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.LockPaymentCondition.md#roleadminchangedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:210 - -___ - -### getRoleGrantedById - -▸ **getRoleGrantedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.LockPaymentCondition.md#rolegrantedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.LockPaymentCondition.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.LockPaymentCondition.md#singlequeryoptions) | -| `args` | [`RoleGrantedArgs`](subgraphs.LockPaymentCondition.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.LockPaymentCondition.md#rolegrantedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:254 - -___ - -### getRoleGranteds - -▸ **getRoleGranteds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.LockPaymentCondition.md#rolegrantedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.LockPaymentCondition.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.LockPaymentCondition.md#multiqueryoptions)<[`RoleGrantedFilter`](subgraphs.LockPaymentCondition.md#rolegrantedfilter), [`RoleGrantedResult`](subgraphs.LockPaymentCondition.md#rolegrantedresult)\> | -| `args` | [`RoleGrantedArgs`](subgraphs.LockPaymentCondition.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.LockPaymentCondition.md#rolegrantedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:255 - -___ - -### getRoleRevokedById - -▸ **getRoleRevokedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.LockPaymentCondition.md#rolerevokedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.LockPaymentCondition.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.LockPaymentCondition.md#singlequeryoptions) | -| `args` | [`RoleRevokedArgs`](subgraphs.LockPaymentCondition.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.LockPaymentCondition.md#rolerevokedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:299 - -___ - -### getRoleRevokeds - -▸ **getRoleRevokeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.LockPaymentCondition.md#rolerevokedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.LockPaymentCondition.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.LockPaymentCondition.md#multiqueryoptions)<[`RoleRevokedFilter`](subgraphs.LockPaymentCondition.md#rolerevokedfilter), [`RoleRevokedResult`](subgraphs.LockPaymentCondition.md#rolerevokedresult)\> | -| `args` | [`RoleRevokedArgs`](subgraphs.LockPaymentCondition.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.LockPaymentCondition.md#rolerevokedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:300 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721AccessProofTemplate.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721AccessProofTemplate.md deleted file mode 100644 index e790367047..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721AccessProofTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NFT721AccessProofTemplate - -# Namespace: NFT721AccessProofTemplate - -[subgraphs](subgraphs.md).NFT721AccessProofTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFT721AccessProofTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFT721AccessProofTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFT721AccessProofTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFT721AccessProofTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFT721AccessProofTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFT721AccessProofTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFT721AccessProofTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFT721AccessProofTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFT721AccessProofTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFT721AccessProofTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFT721AccessProofTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFT721AccessProofTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:117 - -___ - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | ``true`` | -| `_accessProvider` | ``true`` | -| `_agreementId` | ``true`` | -| `_conditionIdSeeds` | ``true`` | -| `_conditionIds` | ``true`` | -| `_creator` | ``true`` | -| `_did` | ``true`` | -| `_idSeed` | ``true`` | -| `_timeLocks` | ``true`` | -| `_timeOuts` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:104 - -___ - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer?` | `string` \| ``null`` | -| `_accessConsumer_contains?` | `string` \| ``null`` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| ``null`` | -| `_accessConsumer_not_contains?` | `string` \| ``null`` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| ``null`` | -| `_accessProvider_contains?` | `string` \| ``null`` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| ``null`` | -| `_accessProvider_not_contains?` | `string` \| ``null`` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| ``null`` | -| `_creator_contains?` | `string` \| ``null`` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| ``null`` | -| `_creator_not_contains?` | `string` \| ``null`` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| ``null`` | -| `_idSeed_contains?` | `string` \| ``null`` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| ``null`` | -| `_idSeed_not_contains?` | `string` \| ``null`` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:21 - -___ - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| ``null``)[] | -| `_conditionIds` | (`string` \| ``null``)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| ``null``)[] | -| `_timeOuts` | (`Wei` \| ``null``)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:91 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721AccessProofTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:148 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:144 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:122 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:140 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:185 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:180 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:153 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:175 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721AccessProofTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:120 - -___ - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721AccessProofTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:121 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessProofTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721AccessProofTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721AccessProofTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFT721AccessProofTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessProofTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:151 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessProofTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721AccessProofTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721AccessProofTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFT721AccessProofTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFT721AccessProofTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFT721AccessProofTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessProofTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:152 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721AccessProofTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:188 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721AccessProofTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:189 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721AccessSwapTemplate.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721AccessSwapTemplate.md deleted file mode 100644 index f5e5070a42..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721AccessSwapTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NFT721AccessSwapTemplate - -# Namespace: NFT721AccessSwapTemplate - -[subgraphs](subgraphs.md).NFT721AccessSwapTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFT721AccessSwapTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFT721AccessSwapTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFT721AccessSwapTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFT721AccessSwapTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFT721AccessSwapTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFT721AccessSwapTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFT721AccessSwapTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFT721AccessSwapTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFT721AccessSwapTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFT721AccessSwapTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFT721AccessSwapTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFT721AccessSwapTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:117 - -___ - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | ``true`` | -| `_accessProvider` | ``true`` | -| `_agreementId` | ``true`` | -| `_conditionIdSeeds` | ``true`` | -| `_conditionIds` | ``true`` | -| `_creator` | ``true`` | -| `_did` | ``true`` | -| `_idSeed` | ``true`` | -| `_timeLocks` | ``true`` | -| `_timeOuts` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:104 - -___ - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer?` | `string` \| ``null`` | -| `_accessConsumer_contains?` | `string` \| ``null`` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| ``null`` | -| `_accessConsumer_not_contains?` | `string` \| ``null`` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| ``null`` | -| `_accessProvider_contains?` | `string` \| ``null`` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| ``null`` | -| `_accessProvider_not_contains?` | `string` \| ``null`` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| ``null`` | -| `_creator_contains?` | `string` \| ``null`` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| ``null`` | -| `_creator_not_contains?` | `string` \| ``null`` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| ``null`` | -| `_idSeed_contains?` | `string` \| ``null`` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| ``null`` | -| `_idSeed_not_contains?` | `string` \| ``null`` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:21 - -___ - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| ``null``)[] | -| `_conditionIds` | (`string` \| ``null``)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| ``null``)[] | -| `_timeOuts` | (`Wei` \| ``null``)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:91 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721AccessSwapTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:148 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:144 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:122 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:140 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:185 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:180 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:153 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:175 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721AccessSwapTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:120 - -___ - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721AccessSwapTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:121 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessSwapTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721AccessSwapTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721AccessSwapTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFT721AccessSwapTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessSwapTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:151 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessSwapTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721AccessSwapTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721AccessSwapTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFT721AccessSwapTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFT721AccessSwapTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFT721AccessSwapTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessSwapTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:152 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721AccessSwapTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:188 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721AccessSwapTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:189 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721AccessTemplate.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721AccessTemplate.md deleted file mode 100644 index 73b2d89120..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721AccessTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NFT721AccessTemplate - -# Namespace: NFT721AccessTemplate - -[subgraphs](subgraphs.md).NFT721AccessTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFT721AccessTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFT721AccessTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFT721AccessTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFT721AccessTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFT721AccessTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFT721AccessTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFT721AccessTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFT721AccessTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFT721AccessTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFT721AccessTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFT721AccessTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFT721AccessTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFT721AccessTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFT721AccessTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFT721AccessTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFT721AccessTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFT721AccessTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFT721AccessTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFT721AccessTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFT721AccessTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721AccessTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:117 - -___ - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | ``true`` | -| `_accessProvider` | ``true`` | -| `_agreementId` | ``true`` | -| `_conditionIdSeeds` | ``true`` | -| `_conditionIds` | ``true`` | -| `_creator` | ``true`` | -| `_did` | ``true`` | -| `_idSeed` | ``true`` | -| `_timeLocks` | ``true`` | -| `_timeOuts` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:104 - -___ - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer?` | `string` \| ``null`` | -| `_accessConsumer_contains?` | `string` \| ``null`` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| ``null`` | -| `_accessConsumer_not_contains?` | `string` \| ``null`` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| ``null`` | -| `_accessProvider_contains?` | `string` \| ``null`` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| ``null`` | -| `_accessProvider_not_contains?` | `string` \| ``null`` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| ``null`` | -| `_creator_contains?` | `string` \| ``null`` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| ``null`` | -| `_creator_not_contains?` | `string` \| ``null`` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| ``null`` | -| `_idSeed_contains?` | `string` \| ``null`` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| ``null`` | -| `_idSeed_not_contains?` | `string` \| ``null`` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:21 - -___ - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| ``null``)[] | -| `_conditionIds` | (`string` \| ``null``)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| ``null``)[] | -| `_timeOuts` | (`Wei` \| ``null``)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:91 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721AccessTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:148 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:144 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:122 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:140 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:185 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:180 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:153 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:175 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721AccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721AccessTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721AccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:120 - -___ - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721AccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721AccessTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFT721AccessTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFT721AccessTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721AccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:121 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721AccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721AccessTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFT721AccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:151 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721AccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721AccessTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFT721AccessTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFT721AccessTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFT721AccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:152 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721AccessTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:188 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721AccessTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:189 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721EscrowPaymentCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721EscrowPaymentCondition.md deleted file mode 100644 index b51c830ef5..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721EscrowPaymentCondition.md +++ /dev/null @@ -1,685 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NFT721EscrowPaymentCondition - -# Namespace: NFT721EscrowPaymentCondition - -[subgraphs](subgraphs.md).NFT721EscrowPaymentCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.NFT721EscrowPaymentCondition.md#initializedargs) -- [InitializedFields](subgraphs.NFT721EscrowPaymentCondition.md#initializedfields) -- [InitializedFilter](subgraphs.NFT721EscrowPaymentCondition.md#initializedfilter) -- [InitializedResult](subgraphs.NFT721EscrowPaymentCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFT721EscrowPaymentCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredresult) -- [ReceivedArgs](subgraphs.NFT721EscrowPaymentCondition.md#receivedargs) -- [ReceivedFields](subgraphs.NFT721EscrowPaymentCondition.md#receivedfields) -- [ReceivedFilter](subgraphs.NFT721EscrowPaymentCondition.md#receivedfilter) -- [ReceivedResult](subgraphs.NFT721EscrowPaymentCondition.md#receivedresult) -- [SingleQueryOptions](subgraphs.NFT721EscrowPaymentCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.NFT721EscrowPaymentCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.NFT721EscrowPaymentCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.NFT721EscrowPaymentCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFT721EscrowPaymentCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFT721EscrowPaymentCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFT721EscrowPaymentCondition.md#getownershiptransferreds) -- [getReceivedById](subgraphs.NFT721EscrowPaymentCondition.md#getreceivedbyid) -- [getReceiveds](subgraphs.NFT721EscrowPaymentCondition.md#getreceiveds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:87 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | ``true`` | -| `_amounts` | ``true`` | -| `_conditionId` | ``true`` | -| `_did` | ``true`` | -| `_receivers` | ``true`` | -| `_tokenAddress` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:78 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_amounts?` | `WeiSource` \| ``null`` | -| `_amounts_gt?` | `WeiSource` \| ``null`` | -| `_amounts_gte?` | `WeiSource` \| ``null`` | -| `_amounts_in?` | `WeiSource`[] | -| `_amounts_lt?` | `WeiSource` \| ``null`` | -| `_amounts_lte?` | `WeiSource` \| ``null`` | -| `_amounts_not?` | `WeiSource` \| ``null`` | -| `_amounts_not_in?` | `WeiSource`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_receivers?` | `string` \| ``null`` | -| `_receivers_contains?` | `string` \| ``null`` | -| `_receivers_in?` | `string`[] | -| `_receivers_not?` | `string` \| ``null`` | -| `_receivers_not_contains?` | `string` \| ``null`` | -| `_receivers_not_in?` | `string`[] | -| `_tokenAddress?` | `string` \| ``null`` | -| `_tokenAddress_contains?` | `string` \| ``null`` | -| `_tokenAddress_in?` | `string`[] | -| `_tokenAddress_not?` | `string` \| ``null`` | -| `_tokenAddress_not_contains?` | `string` \| ``null`` | -| `_tokenAddress_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:21 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | `string` | -| `_amounts` | `Wei` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `_receivers` | `string` | -| `_tokenAddress` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:69 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721EscrowPaymentCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:118 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:114 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:92 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:110 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:155 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:150 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:123 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:145 - -___ - -### ReceivedArgs - -Ƭ **ReceivedArgs**<`K`\>: { [Property in keyof Pick]: ReceivedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ReceivedResult`](subgraphs.NFT721EscrowPaymentCondition.md#receivedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:194 - -___ - -### ReceivedFields - -Ƭ **ReceivedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_from` | ``true`` | -| `_value` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:189 - -___ - -### ReceivedFilter - -Ƭ **ReceivedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_from?` | `string` \| ``null`` | -| `_from_contains?` | `string` \| ``null`` | -| `_from_in?` | `string`[] | -| `_from_not?` | `string` \| ``null`` | -| `_from_not_contains?` | `string` \| ``null`` | -| `_from_not_in?` | `string`[] | -| `_value?` | `WeiSource` \| ``null`` | -| `_value_gt?` | `WeiSource` \| ``null`` | -| `_value_gte?` | `WeiSource` \| ``null`` | -| `_value_in?` | `WeiSource`[] | -| `_value_lt?` | `WeiSource` \| ``null`` | -| `_value_lte?` | `WeiSource` \| ``null`` | -| `_value_not?` | `WeiSource` \| ``null`` | -| `_value_not_in?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:160 - -___ - -### ReceivedResult - -Ƭ **ReceivedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_from` | `string` | -| `_value` | `Wei` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:184 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721EscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:90 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721EscrowPaymentCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:91 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721EscrowPaymentCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721EscrowPaymentCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721EscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFT721EscrowPaymentCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721EscrowPaymentCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:121 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721EscrowPaymentCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721EscrowPaymentCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721EscrowPaymentCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFT721EscrowPaymentCondition.md#initializedfilter), [`InitializedResult`](subgraphs.NFT721EscrowPaymentCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFT721EscrowPaymentCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721EscrowPaymentCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:122 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721EscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:158 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721EscrowPaymentCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:159 - -___ - -### getReceivedById - -▸ **getReceivedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ReceivedResult`](subgraphs.NFT721EscrowPaymentCondition.md#receivedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ReceivedResult`](subgraphs.NFT721EscrowPaymentCondition.md#receivedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721EscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`ReceivedArgs`](subgraphs.NFT721EscrowPaymentCondition.md#receivedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ReceivedResult`](subgraphs.NFT721EscrowPaymentCondition.md#receivedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:197 - -___ - -### getReceiveds - -▸ **getReceiveds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ReceivedResult`](subgraphs.NFT721EscrowPaymentCondition.md#receivedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ReceivedResult`](subgraphs.NFT721EscrowPaymentCondition.md#receivedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721EscrowPaymentCondition.md#multiqueryoptions)<[`ReceivedFilter`](subgraphs.NFT721EscrowPaymentCondition.md#receivedfilter), [`ReceivedResult`](subgraphs.NFT721EscrowPaymentCondition.md#receivedresult)\> | -| `args` | [`ReceivedArgs`](subgraphs.NFT721EscrowPaymentCondition.md#receivedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ReceivedResult`](subgraphs.NFT721EscrowPaymentCondition.md#receivedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:198 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721HolderCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721HolderCondition.md deleted file mode 100644 index 0477e091f3..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721HolderCondition.md +++ /dev/null @@ -1,526 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NFT721HolderCondition - -# Namespace: NFT721HolderCondition - -[subgraphs](subgraphs.md).NFT721HolderCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.NFT721HolderCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.NFT721HolderCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.NFT721HolderCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.NFT721HolderCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.NFT721HolderCondition.md#initializedargs) -- [InitializedFields](subgraphs.NFT721HolderCondition.md#initializedfields) -- [InitializedFilter](subgraphs.NFT721HolderCondition.md#initializedfilter) -- [InitializedResult](subgraphs.NFT721HolderCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFT721HolderCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFT721HolderCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFT721HolderCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFT721HolderCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFT721HolderCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFT721HolderCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.NFT721HolderCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.NFT721HolderCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.NFT721HolderCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFT721HolderCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFT721HolderCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFT721HolderCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFT721HolderCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:79 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_address` | ``true`` | -| `_agreementId` | ``true`` | -| `_amount` | ``true`` | -| `_conditionId` | ``true`` | -| `_did` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:71 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_address?` | `string` \| ``null`` | -| `_address_contains?` | `string` \| ``null`` | -| `_address_in?` | `string`[] | -| `_address_not?` | `string` \| ``null`` | -| `_address_not_contains?` | `string` \| ``null`` | -| `_address_not_in?` | `string`[] | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_amount?` | `WeiSource` \| ``null`` | -| `_amount_gt?` | `WeiSource` \| ``null`` | -| `_amount_gte?` | `WeiSource` \| ``null`` | -| `_amount_in?` | `WeiSource`[] | -| `_amount_lt?` | `WeiSource` \| ``null`` | -| `_amount_lte?` | `WeiSource` \| ``null`` | -| `_amount_not?` | `WeiSource` \| ``null`` | -| `_amount_not_in?` | `WeiSource`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:21 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_address` | `string` | -| `_agreementId` | `string` | -| `_amount` | `Wei` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:63 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721HolderCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:110 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:106 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:84 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:102 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721HolderCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:147 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:142 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:115 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:137 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721HolderCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFT721HolderCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721HolderCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.NFT721HolderCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721HolderCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:82 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721HolderCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFT721HolderCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721HolderCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.NFT721HolderCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.NFT721HolderCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.NFT721HolderCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721HolderCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:83 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721HolderCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721HolderCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721HolderCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFT721HolderCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721HolderCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:113 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721HolderCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721HolderCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721HolderCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFT721HolderCondition.md#initializedfilter), [`InitializedResult`](subgraphs.NFT721HolderCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFT721HolderCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721HolderCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:114 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721HolderCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721HolderCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721HolderCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721HolderCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721HolderCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:150 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721HolderCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721HolderCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721HolderCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFT721HolderCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFT721HolderCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721HolderCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721HolderCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:151 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721LockCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721LockCondition.md deleted file mode 100644 index d68d34596d..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721LockCondition.md +++ /dev/null @@ -1,391 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NFT721LockCondition - -# Namespace: NFT721LockCondition - -[subgraphs](subgraphs.md).NFT721LockCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.NFT721LockCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.NFT721LockCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.NFT721LockCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.NFT721LockCondition.md#fulfilledresult) -- [MultiQueryOptions](subgraphs.NFT721LockCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFT721LockCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFT721LockCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFT721LockCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFT721LockCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFT721LockCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.NFT721LockCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.NFT721LockCondition.md#getfulfilleds) -- [getOwnershipTransferredById](subgraphs.NFT721LockCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFT721LockCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFT721LockCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:87 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | ``true`` | -| `_amount` | ``true`` | -| `_conditionId` | ``true`` | -| `_did` | ``true`` | -| `_lockAddress` | ``true`` | -| `_nftContractAddress` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:78 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_amount?` | `WeiSource` \| ``null`` | -| `_amount_gt?` | `WeiSource` \| ``null`` | -| `_amount_gte?` | `WeiSource` \| ``null`` | -| `_amount_in?` | `WeiSource`[] | -| `_amount_lt?` | `WeiSource` \| ``null`` | -| `_amount_lte?` | `WeiSource` \| ``null`` | -| `_amount_not?` | `WeiSource` \| ``null`` | -| `_amount_not_in?` | `WeiSource`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_lockAddress?` | `string` \| ``null`` | -| `_lockAddress_contains?` | `string` \| ``null`` | -| `_lockAddress_in?` | `string`[] | -| `_lockAddress_not?` | `string` \| ``null`` | -| `_lockAddress_not_contains?` | `string` \| ``null`` | -| `_lockAddress_not_in?` | `string`[] | -| `_nftContractAddress?` | `string` \| ``null`` | -| `_nftContractAddress_contains?` | `string` \| ``null`` | -| `_nftContractAddress_in?` | `string`[] | -| `_nftContractAddress_not?` | `string` \| ``null`` | -| `_nftContractAddress_not_contains?` | `string` \| ``null`` | -| `_nftContractAddress_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:21 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | `string` | -| `_amount` | `Wei` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `_lockAddress` | `string` | -| `_nftContractAddress` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:69 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721LockCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:124 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:119 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:92 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:114 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721LockCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFT721LockCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721LockCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.NFT721LockCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721LockCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:90 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721LockCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFT721LockCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721LockCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.NFT721LockCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.NFT721LockCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.NFT721LockCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721LockCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:91 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721LockCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721LockCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721LockCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721LockCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721LockCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:127 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721LockCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721LockCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721LockCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFT721LockCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFT721LockCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721LockCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721LockCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:128 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721SalesTemplate.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721SalesTemplate.md deleted file mode 100644 index f82f60ed66..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721SalesTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NFT721SalesTemplate - -# Namespace: NFT721SalesTemplate - -[subgraphs](subgraphs.md).NFT721SalesTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFT721SalesTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFT721SalesTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFT721SalesTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFT721SalesTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFT721SalesTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFT721SalesTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFT721SalesTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFT721SalesTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFT721SalesTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFT721SalesTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFT721SalesTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFT721SalesTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFT721SalesTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFT721SalesTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFT721SalesTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFT721SalesTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFT721SalesTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFT721SalesTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFT721SalesTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFT721SalesTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721SalesTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:117 - -___ - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | ``true`` | -| `_accessProvider` | ``true`` | -| `_agreementId` | ``true`` | -| `_conditionIdSeeds` | ``true`` | -| `_conditionIds` | ``true`` | -| `_creator` | ``true`` | -| `_did` | ``true`` | -| `_idSeed` | ``true`` | -| `_timeLocks` | ``true`` | -| `_timeOuts` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:104 - -___ - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer?` | `string` \| ``null`` | -| `_accessConsumer_contains?` | `string` \| ``null`` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| ``null`` | -| `_accessConsumer_not_contains?` | `string` \| ``null`` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| ``null`` | -| `_accessProvider_contains?` | `string` \| ``null`` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| ``null`` | -| `_accessProvider_not_contains?` | `string` \| ``null`` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| ``null`` | -| `_creator_contains?` | `string` \| ``null`` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| ``null`` | -| `_creator_not_contains?` | `string` \| ``null`` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| ``null`` | -| `_idSeed_contains?` | `string` \| ``null`` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| ``null`` | -| `_idSeed_not_contains?` | `string` \| ``null`` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:21 - -___ - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| ``null``)[] | -| `_conditionIds` | (`string` \| ``null``)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| ``null``)[] | -| `_timeOuts` | (`Wei` \| ``null``)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:91 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721SalesTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:148 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:144 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:122 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:140 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:185 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:180 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:153 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:175 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721SalesTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721SalesTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721SalesTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721SalesTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721SalesTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:120 - -___ - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721SalesTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721SalesTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721SalesTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFT721SalesTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFT721SalesTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721SalesTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721SalesTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:121 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721SalesTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721SalesTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721SalesTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFT721SalesTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721SalesTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:151 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721SalesTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721SalesTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721SalesTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFT721SalesTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFT721SalesTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFT721SalesTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721SalesTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:152 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721SalesTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:188 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721SalesTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:189 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721SalesWithAccessTemplate.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721SalesWithAccessTemplate.md deleted file mode 100644 index f51d123677..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721SalesWithAccessTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NFT721SalesWithAccessTemplate - -# Namespace: NFT721SalesWithAccessTemplate - -[subgraphs](subgraphs.md).NFT721SalesWithAccessTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFT721SalesWithAccessTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFT721SalesWithAccessTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFT721SalesWithAccessTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFT721SalesWithAccessTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFT721SalesWithAccessTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFT721SalesWithAccessTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFT721SalesWithAccessTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFT721SalesWithAccessTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFT721SalesWithAccessTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFT721SalesWithAccessTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFT721SalesWithAccessTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFT721SalesWithAccessTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:117 - -___ - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | ``true`` | -| `_accessProvider` | ``true`` | -| `_agreementId` | ``true`` | -| `_conditionIdSeeds` | ``true`` | -| `_conditionIds` | ``true`` | -| `_creator` | ``true`` | -| `_did` | ``true`` | -| `_idSeed` | ``true`` | -| `_timeLocks` | ``true`` | -| `_timeOuts` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:104 - -___ - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer?` | `string` \| ``null`` | -| `_accessConsumer_contains?` | `string` \| ``null`` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| ``null`` | -| `_accessConsumer_not_contains?` | `string` \| ``null`` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| ``null`` | -| `_accessProvider_contains?` | `string` \| ``null`` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| ``null`` | -| `_accessProvider_not_contains?` | `string` \| ``null`` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| ``null`` | -| `_creator_contains?` | `string` \| ``null`` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| ``null`` | -| `_creator_not_contains?` | `string` \| ``null`` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| ``null`` | -| `_idSeed_contains?` | `string` \| ``null`` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| ``null`` | -| `_idSeed_not_contains?` | `string` \| ``null`` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:21 - -___ - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| ``null``)[] | -| `_conditionIds` | (`string` \| ``null``)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| ``null``)[] | -| `_timeOuts` | (`Wei` \| ``null``)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:91 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:148 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:144 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:122 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:140 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:185 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:180 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:153 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:175 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721SalesWithAccessTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:120 - -___ - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721SalesWithAccessTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:121 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721SalesWithAccessTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:151 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721SalesWithAccessTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:152 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721SalesWithAccessTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:188 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721SalesWithAccessTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:189 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721Upgradeable.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721Upgradeable.md deleted file mode 100644 index 40853c37c7..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFT721Upgradeable.md +++ /dev/null @@ -1,1450 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NFT721Upgradeable - -# Namespace: NFT721Upgradeable - -[subgraphs](subgraphs.md).NFT721Upgradeable - -## Table of contents - -### Type Aliases - -- [ApprovalArgs](subgraphs.NFT721Upgradeable.md#approvalargs) -- [ApprovalFields](subgraphs.NFT721Upgradeable.md#approvalfields) -- [ApprovalFilter](subgraphs.NFT721Upgradeable.md#approvalfilter) -- [ApprovalForAllArgs](subgraphs.NFT721Upgradeable.md#approvalforallargs) -- [ApprovalForAllFields](subgraphs.NFT721Upgradeable.md#approvalforallfields) -- [ApprovalForAllFilter](subgraphs.NFT721Upgradeable.md#approvalforallfilter) -- [ApprovalForAllResult](subgraphs.NFT721Upgradeable.md#approvalforallresult) -- [ApprovalResult](subgraphs.NFT721Upgradeable.md#approvalresult) -- [InitializedArgs](subgraphs.NFT721Upgradeable.md#initializedargs) -- [InitializedFields](subgraphs.NFT721Upgradeable.md#initializedfields) -- [InitializedFilter](subgraphs.NFT721Upgradeable.md#initializedfilter) -- [InitializedResult](subgraphs.NFT721Upgradeable.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFT721Upgradeable.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFT721Upgradeable.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFT721Upgradeable.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFT721Upgradeable.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFT721Upgradeable.md#ownershiptransferredresult) -- [ProxyApprovalArgs](subgraphs.NFT721Upgradeable.md#proxyapprovalargs) -- [ProxyApprovalFields](subgraphs.NFT721Upgradeable.md#proxyapprovalfields) -- [ProxyApprovalFilter](subgraphs.NFT721Upgradeable.md#proxyapprovalfilter) -- [ProxyApprovalResult](subgraphs.NFT721Upgradeable.md#proxyapprovalresult) -- [RoleAdminChangedArgs](subgraphs.NFT721Upgradeable.md#roleadminchangedargs) -- [RoleAdminChangedFields](subgraphs.NFT721Upgradeable.md#roleadminchangedfields) -- [RoleAdminChangedFilter](subgraphs.NFT721Upgradeable.md#roleadminchangedfilter) -- [RoleAdminChangedResult](subgraphs.NFT721Upgradeable.md#roleadminchangedresult) -- [RoleGrantedArgs](subgraphs.NFT721Upgradeable.md#rolegrantedargs) -- [RoleGrantedFields](subgraphs.NFT721Upgradeable.md#rolegrantedfields) -- [RoleGrantedFilter](subgraphs.NFT721Upgradeable.md#rolegrantedfilter) -- [RoleGrantedResult](subgraphs.NFT721Upgradeable.md#rolegrantedresult) -- [RoleRevokedArgs](subgraphs.NFT721Upgradeable.md#rolerevokedargs) -- [RoleRevokedFields](subgraphs.NFT721Upgradeable.md#rolerevokedfields) -- [RoleRevokedFilter](subgraphs.NFT721Upgradeable.md#rolerevokedfilter) -- [RoleRevokedResult](subgraphs.NFT721Upgradeable.md#rolerevokedresult) -- [SingleQueryOptions](subgraphs.NFT721Upgradeable.md#singlequeryoptions) -- [TransferArgs](subgraphs.NFT721Upgradeable.md#transferargs) -- [TransferFields](subgraphs.NFT721Upgradeable.md#transferfields) -- [TransferFilter](subgraphs.NFT721Upgradeable.md#transferfilter) -- [TransferResult](subgraphs.NFT721Upgradeable.md#transferresult) - -### Functions - -- [getApprovalById](subgraphs.NFT721Upgradeable.md#getapprovalbyid) -- [getApprovalForAllById](subgraphs.NFT721Upgradeable.md#getapprovalforallbyid) -- [getApprovalForAlls](subgraphs.NFT721Upgradeable.md#getapprovalforalls) -- [getApprovals](subgraphs.NFT721Upgradeable.md#getapprovals) -- [getInitializedById](subgraphs.NFT721Upgradeable.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFT721Upgradeable.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFT721Upgradeable.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFT721Upgradeable.md#getownershiptransferreds) -- [getProxyApprovalById](subgraphs.NFT721Upgradeable.md#getproxyapprovalbyid) -- [getProxyApprovals](subgraphs.NFT721Upgradeable.md#getproxyapprovals) -- [getRoleAdminChangedById](subgraphs.NFT721Upgradeable.md#getroleadminchangedbyid) -- [getRoleAdminChangeds](subgraphs.NFT721Upgradeable.md#getroleadminchangeds) -- [getRoleGrantedById](subgraphs.NFT721Upgradeable.md#getrolegrantedbyid) -- [getRoleGranteds](subgraphs.NFT721Upgradeable.md#getrolegranteds) -- [getRoleRevokedById](subgraphs.NFT721Upgradeable.md#getrolerevokedbyid) -- [getRoleRevokeds](subgraphs.NFT721Upgradeable.md#getrolerevokeds) -- [getTransferById](subgraphs.NFT721Upgradeable.md#gettransferbyid) -- [getTransfers](subgraphs.NFT721Upgradeable.md#gettransfers) - -## Type Aliases - -### ApprovalArgs - -Ƭ **ApprovalArgs**<`K`\>: { [Property in keyof Pick]: ApprovalFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ApprovalResult`](subgraphs.NFT721Upgradeable.md#approvalresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:63 - -___ - -### ApprovalFields - -Ƭ **ApprovalFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `approved` | ``true`` | -| `id` | ``true`` | -| `owner` | ``true`` | -| `tokenId` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:57 - -___ - -### ApprovalFilter - -Ƭ **ApprovalFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `approved?` | `string` \| ``null`` | -| `approved_contains?` | `string` \| ``null`` | -| `approved_in?` | `string`[] | -| `approved_not?` | `string` \| ``null`` | -| `approved_not_contains?` | `string` \| ``null`` | -| `approved_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `owner?` | `string` \| ``null`` | -| `owner_contains?` | `string` \| ``null`` | -| `owner_in?` | `string`[] | -| `owner_not?` | `string` \| ``null`` | -| `owner_not_contains?` | `string` \| ``null`` | -| `owner_not_in?` | `string`[] | -| `tokenId?` | `WeiSource` \| ``null`` | -| `tokenId_gt?` | `WeiSource` \| ``null`` | -| `tokenId_gte?` | `WeiSource` \| ``null`` | -| `tokenId_in?` | `WeiSource`[] | -| `tokenId_lt?` | `WeiSource` \| ``null`` | -| `tokenId_lte?` | `WeiSource` \| ``null`` | -| `tokenId_not?` | `WeiSource` \| ``null`` | -| `tokenId_not_in?` | `WeiSource`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:21 - -___ - -### ApprovalForAllArgs - -Ƭ **ApprovalForAllArgs**<`K`\>: { [Property in keyof Pick]: ApprovalForAllFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ApprovalForAllResult`](subgraphs.NFT721Upgradeable.md#approvalforallresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:106 - -___ - -### ApprovalForAllFields - -Ƭ **ApprovalForAllFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `approved` | ``true`` | -| `id` | ``true`` | -| `operator` | ``true`` | -| `owner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:100 - -___ - -### ApprovalForAllFilter - -Ƭ **ApprovalForAllFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `approved?` | `boolean` \| ``null`` | -| `approved_in?` | `boolean`[] | -| `approved_not?` | `boolean` \| ``null`` | -| `approved_not_in?` | `boolean`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `operator?` | `string` \| ``null`` | -| `operator_contains?` | `string` \| ``null`` | -| `operator_in?` | `string`[] | -| `operator_not?` | `string` \| ``null`` | -| `operator_not_contains?` | `string` \| ``null`` | -| `operator_not_in?` | `string`[] | -| `owner?` | `string` \| ``null`` | -| `owner_contains?` | `string` \| ``null`` | -| `owner_in?` | `string`[] | -| `owner_not?` | `string` \| ``null`` | -| `owner_not_contains?` | `string` \| ``null`` | -| `owner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:68 - -___ - -### ApprovalForAllResult - -Ƭ **ApprovalForAllResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `approved` | `boolean` | -| `id` | `string` | -| `operator` | `string` | -| `owner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:94 - -___ - -### ApprovalResult - -Ƭ **ApprovalResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `approved` | `string` | -| `id` | `string` | -| `owner` | `string` | -| `tokenId` | `Wei` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:51 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721Upgradeable.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:137 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:133 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:111 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:129 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721Upgradeable.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:174 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:169 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:142 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:164 - -___ - -### ProxyApprovalArgs - -Ƭ **ProxyApprovalArgs**<`K`\>: { [Property in keyof Pick]: ProxyApprovalFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ProxyApprovalResult`](subgraphs.NFT721Upgradeable.md#proxyapprovalresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:217 - -___ - -### ProxyApprovalFields - -Ƭ **ProxyApprovalFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `approved` | ``true`` | -| `id` | ``true`` | -| `operator` | ``true`` | -| `sender` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:211 - -___ - -### ProxyApprovalFilter - -Ƭ **ProxyApprovalFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `approved?` | `boolean` \| ``null`` | -| `approved_in?` | `boolean`[] | -| `approved_not?` | `boolean` \| ``null`` | -| `approved_not_in?` | `boolean`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `operator?` | `string` \| ``null`` | -| `operator_contains?` | `string` \| ``null`` | -| `operator_in?` | `string`[] | -| `operator_not?` | `string` \| ``null`` | -| `operator_not_contains?` | `string` \| ``null`` | -| `operator_not_in?` | `string`[] | -| `sender?` | `string` \| ``null`` | -| `sender_contains?` | `string` \| ``null`` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| ``null`` | -| `sender_not_contains?` | `string` \| ``null`` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:179 - -___ - -### ProxyApprovalResult - -Ƭ **ProxyApprovalResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `approved` | `boolean` | -| `id` | `string` | -| `operator` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:205 - -___ - -### RoleAdminChangedArgs - -Ƭ **RoleAdminChangedArgs**<`K`\>: { [Property in keyof Pick]: RoleAdminChangedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.NFT721Upgradeable.md#roleadminchangedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:262 - -___ - -### RoleAdminChangedFields - -Ƭ **RoleAdminChangedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newAdminRole` | ``true`` | -| `previousAdminRole` | ``true`` | -| `role` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:256 - -___ - -### RoleAdminChangedFilter - -Ƭ **RoleAdminChangedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newAdminRole?` | `string` \| ``null`` | -| `newAdminRole_contains?` | `string` \| ``null`` | -| `newAdminRole_in?` | `string`[] | -| `newAdminRole_not?` | `string` \| ``null`` | -| `newAdminRole_not_contains?` | `string` \| ``null`` | -| `newAdminRole_not_in?` | `string`[] | -| `previousAdminRole?` | `string` \| ``null`` | -| `previousAdminRole_contains?` | `string` \| ``null`` | -| `previousAdminRole_in?` | `string`[] | -| `previousAdminRole_not?` | `string` \| ``null`` | -| `previousAdminRole_not_contains?` | `string` \| ``null`` | -| `previousAdminRole_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:222 - -___ - -### RoleAdminChangedResult - -Ƭ **RoleAdminChangedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newAdminRole` | `string` | -| `previousAdminRole` | `string` | -| `role` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:250 - -___ - -### RoleGrantedArgs - -Ƭ **RoleGrantedArgs**<`K`\>: { [Property in keyof Pick]: RoleGrantedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.NFT721Upgradeable.md#rolegrantedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:307 - -___ - -### RoleGrantedFields - -Ƭ **RoleGrantedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | ``true`` | -| `id` | ``true`` | -| `role` | ``true`` | -| `sender` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:301 - -___ - -### RoleGrantedFilter - -Ƭ **RoleGrantedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account?` | `string` \| ``null`` | -| `account_contains?` | `string` \| ``null`` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| ``null`` | -| `account_not_contains?` | `string` \| ``null`` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| ``null`` | -| `sender_contains?` | `string` \| ``null`` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| ``null`` | -| `sender_not_contains?` | `string` \| ``null`` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:267 - -___ - -### RoleGrantedResult - -Ƭ **RoleGrantedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:295 - -___ - -### RoleRevokedArgs - -Ƭ **RoleRevokedArgs**<`K`\>: { [Property in keyof Pick]: RoleRevokedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.NFT721Upgradeable.md#rolerevokedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:352 - -___ - -### RoleRevokedFields - -Ƭ **RoleRevokedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | ``true`` | -| `id` | ``true`` | -| `role` | ``true`` | -| `sender` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:346 - -___ - -### RoleRevokedFilter - -Ƭ **RoleRevokedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account?` | `string` \| ``null`` | -| `account_contains?` | `string` \| ``null`` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| ``null`` | -| `account_not_contains?` | `string` \| ``null`` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| ``null`` | -| `sender_contains?` | `string` \| ``null`` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| ``null`` | -| `sender_not_contains?` | `string` \| ``null`` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:312 - -___ - -### RoleRevokedResult - -Ƭ **RoleRevokedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:340 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:2 - -___ - -### TransferArgs - -Ƭ **TransferArgs**<`K`\>: { [Property in keyof Pick]: TransferFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`TransferResult`](subgraphs.NFT721Upgradeable.md#transferresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:399 - -___ - -### TransferFields - -Ƭ **TransferFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `from` | ``true`` | -| `id` | ``true`` | -| `to` | ``true`` | -| `tokenId` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:393 - -___ - -### TransferFilter - -Ƭ **TransferFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `from?` | `string` \| ``null`` | -| `from_contains?` | `string` \| ``null`` | -| `from_in?` | `string`[] | -| `from_not?` | `string` \| ``null`` | -| `from_not_contains?` | `string` \| ``null`` | -| `from_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `to?` | `string` \| ``null`` | -| `to_contains?` | `string` \| ``null`` | -| `to_in?` | `string`[] | -| `to_not?` | `string` \| ``null`` | -| `to_not_contains?` | `string` \| ``null`` | -| `to_not_in?` | `string`[] | -| `tokenId?` | `WeiSource` \| ``null`` | -| `tokenId_gt?` | `WeiSource` \| ``null`` | -| `tokenId_gte?` | `WeiSource` \| ``null`` | -| `tokenId_in?` | `WeiSource`[] | -| `tokenId_lt?` | `WeiSource` \| ``null`` | -| `tokenId_lte?` | `WeiSource` \| ``null`` | -| `tokenId_not?` | `WeiSource` \| ``null`` | -| `tokenId_not_in?` | `WeiSource`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:357 - -___ - -### TransferResult - -Ƭ **TransferResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `from` | `string` | -| `id` | `string` | -| `to` | `string` | -| `tokenId` | `Wei` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:387 - -## Functions - -### getApprovalById - -▸ **getApprovalById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ApprovalResult`](subgraphs.NFT721Upgradeable.md#approvalresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ApprovalResult`](subgraphs.NFT721Upgradeable.md#approvalresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721Upgradeable.md#singlequeryoptions) | -| `args` | [`ApprovalArgs`](subgraphs.NFT721Upgradeable.md#approvalargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ApprovalResult`](subgraphs.NFT721Upgradeable.md#approvalresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:66 - -___ - -### getApprovalForAllById - -▸ **getApprovalForAllById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ApprovalForAllResult`](subgraphs.NFT721Upgradeable.md#approvalforallresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ApprovalForAllResult`](subgraphs.NFT721Upgradeable.md#approvalforallresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721Upgradeable.md#singlequeryoptions) | -| `args` | [`ApprovalForAllArgs`](subgraphs.NFT721Upgradeable.md#approvalforallargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ApprovalForAllResult`](subgraphs.NFT721Upgradeable.md#approvalforallresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:109 - -___ - -### getApprovalForAlls - -▸ **getApprovalForAlls**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ApprovalForAllResult`](subgraphs.NFT721Upgradeable.md#approvalforallresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ApprovalForAllResult`](subgraphs.NFT721Upgradeable.md#approvalforallresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721Upgradeable.md#multiqueryoptions)<[`ApprovalForAllFilter`](subgraphs.NFT721Upgradeable.md#approvalforallfilter), [`ApprovalForAllResult`](subgraphs.NFT721Upgradeable.md#approvalforallresult)\> | -| `args` | [`ApprovalForAllArgs`](subgraphs.NFT721Upgradeable.md#approvalforallargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ApprovalForAllResult`](subgraphs.NFT721Upgradeable.md#approvalforallresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:110 - -___ - -### getApprovals - -▸ **getApprovals**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ApprovalResult`](subgraphs.NFT721Upgradeable.md#approvalresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ApprovalResult`](subgraphs.NFT721Upgradeable.md#approvalresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721Upgradeable.md#multiqueryoptions)<[`ApprovalFilter`](subgraphs.NFT721Upgradeable.md#approvalfilter), [`ApprovalResult`](subgraphs.NFT721Upgradeable.md#approvalresult)\> | -| `args` | [`ApprovalArgs`](subgraphs.NFT721Upgradeable.md#approvalargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ApprovalResult`](subgraphs.NFT721Upgradeable.md#approvalresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:67 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721Upgradeable.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721Upgradeable.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721Upgradeable.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFT721Upgradeable.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721Upgradeable.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:140 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721Upgradeable.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721Upgradeable.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721Upgradeable.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFT721Upgradeable.md#initializedfilter), [`InitializedResult`](subgraphs.NFT721Upgradeable.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFT721Upgradeable.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721Upgradeable.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:141 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721Upgradeable.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721Upgradeable.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721Upgradeable.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721Upgradeable.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721Upgradeable.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:177 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721Upgradeable.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721Upgradeable.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721Upgradeable.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFT721Upgradeable.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFT721Upgradeable.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721Upgradeable.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721Upgradeable.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:178 - -___ - -### getProxyApprovalById - -▸ **getProxyApprovalById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ProxyApprovalResult`](subgraphs.NFT721Upgradeable.md#proxyapprovalresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ProxyApprovalResult`](subgraphs.NFT721Upgradeable.md#proxyapprovalresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721Upgradeable.md#singlequeryoptions) | -| `args` | [`ProxyApprovalArgs`](subgraphs.NFT721Upgradeable.md#proxyapprovalargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ProxyApprovalResult`](subgraphs.NFT721Upgradeable.md#proxyapprovalresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:220 - -___ - -### getProxyApprovals - -▸ **getProxyApprovals**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ProxyApprovalResult`](subgraphs.NFT721Upgradeable.md#proxyapprovalresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ProxyApprovalResult`](subgraphs.NFT721Upgradeable.md#proxyapprovalresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721Upgradeable.md#multiqueryoptions)<[`ProxyApprovalFilter`](subgraphs.NFT721Upgradeable.md#proxyapprovalfilter), [`ProxyApprovalResult`](subgraphs.NFT721Upgradeable.md#proxyapprovalresult)\> | -| `args` | [`ProxyApprovalArgs`](subgraphs.NFT721Upgradeable.md#proxyapprovalargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ProxyApprovalResult`](subgraphs.NFT721Upgradeable.md#proxyapprovalresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:221 - -___ - -### getRoleAdminChangedById - -▸ **getRoleAdminChangedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NFT721Upgradeable.md#roleadminchangedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.NFT721Upgradeable.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721Upgradeable.md#singlequeryoptions) | -| `args` | [`RoleAdminChangedArgs`](subgraphs.NFT721Upgradeable.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NFT721Upgradeable.md#roleadminchangedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:265 - -___ - -### getRoleAdminChangeds - -▸ **getRoleAdminChangeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NFT721Upgradeable.md#roleadminchangedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.NFT721Upgradeable.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721Upgradeable.md#multiqueryoptions)<[`RoleAdminChangedFilter`](subgraphs.NFT721Upgradeable.md#roleadminchangedfilter), [`RoleAdminChangedResult`](subgraphs.NFT721Upgradeable.md#roleadminchangedresult)\> | -| `args` | [`RoleAdminChangedArgs`](subgraphs.NFT721Upgradeable.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NFT721Upgradeable.md#roleadminchangedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:266 - -___ - -### getRoleGrantedById - -▸ **getRoleGrantedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NFT721Upgradeable.md#rolegrantedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.NFT721Upgradeable.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721Upgradeable.md#singlequeryoptions) | -| `args` | [`RoleGrantedArgs`](subgraphs.NFT721Upgradeable.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NFT721Upgradeable.md#rolegrantedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:310 - -___ - -### getRoleGranteds - -▸ **getRoleGranteds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NFT721Upgradeable.md#rolegrantedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.NFT721Upgradeable.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721Upgradeable.md#multiqueryoptions)<[`RoleGrantedFilter`](subgraphs.NFT721Upgradeable.md#rolegrantedfilter), [`RoleGrantedResult`](subgraphs.NFT721Upgradeable.md#rolegrantedresult)\> | -| `args` | [`RoleGrantedArgs`](subgraphs.NFT721Upgradeable.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NFT721Upgradeable.md#rolegrantedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:311 - -___ - -### getRoleRevokedById - -▸ **getRoleRevokedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NFT721Upgradeable.md#rolerevokedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.NFT721Upgradeable.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721Upgradeable.md#singlequeryoptions) | -| `args` | [`RoleRevokedArgs`](subgraphs.NFT721Upgradeable.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NFT721Upgradeable.md#rolerevokedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:355 - -___ - -### getRoleRevokeds - -▸ **getRoleRevokeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NFT721Upgradeable.md#rolerevokedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.NFT721Upgradeable.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721Upgradeable.md#multiqueryoptions)<[`RoleRevokedFilter`](subgraphs.NFT721Upgradeable.md#rolerevokedfilter), [`RoleRevokedResult`](subgraphs.NFT721Upgradeable.md#rolerevokedresult)\> | -| `args` | [`RoleRevokedArgs`](subgraphs.NFT721Upgradeable.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NFT721Upgradeable.md#rolerevokedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:356 - -___ - -### getTransferById - -▸ **getTransferById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`TransferResult`](subgraphs.NFT721Upgradeable.md#transferresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`TransferResult`](subgraphs.NFT721Upgradeable.md#transferresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721Upgradeable.md#singlequeryoptions) | -| `args` | [`TransferArgs`](subgraphs.NFT721Upgradeable.md#transferargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`TransferResult`](subgraphs.NFT721Upgradeable.md#transferresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:402 - -___ - -### getTransfers - -▸ **getTransfers**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`TransferResult`](subgraphs.NFT721Upgradeable.md#transferresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`TransferResult`](subgraphs.NFT721Upgradeable.md#transferresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721Upgradeable.md#multiqueryoptions)<[`TransferFilter`](subgraphs.NFT721Upgradeable.md#transferfilter), [`TransferResult`](subgraphs.NFT721Upgradeable.md#transferresult)\> | -| `args` | [`TransferArgs`](subgraphs.NFT721Upgradeable.md#transferargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`TransferResult`](subgraphs.NFT721Upgradeable.md#transferresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:403 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTAccessCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTAccessCondition.md deleted file mode 100644 index a7741c4eed..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTAccessCondition.md +++ /dev/null @@ -1,516 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NFTAccessCondition - -# Namespace: NFTAccessCondition - -[subgraphs](subgraphs.md).NFTAccessCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.NFTAccessCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.NFTAccessCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.NFTAccessCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.NFTAccessCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.NFTAccessCondition.md#initializedargs) -- [InitializedFields](subgraphs.NFTAccessCondition.md#initializedfields) -- [InitializedFilter](subgraphs.NFTAccessCondition.md#initializedfilter) -- [InitializedResult](subgraphs.NFTAccessCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFTAccessCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFTAccessCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFTAccessCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFTAccessCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFTAccessCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFTAccessCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.NFTAccessCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.NFTAccessCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.NFTAccessCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFTAccessCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFTAccessCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFTAccessCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTAccessCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:68 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | ``true`` | -| `_conditionId` | ``true`` | -| `_documentId` | ``true`` | -| `_grantee` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:61 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_documentId?` | `string` \| ``null`` | -| `_documentId_contains?` | `string` \| ``null`` | -| `_documentId_in?` | `string`[] | -| `_documentId_not?` | `string` \| ``null`` | -| `_documentId_not_contains?` | `string` \| ``null`` | -| `_documentId_not_in?` | `string`[] | -| `_grantee?` | `string` \| ``null`` | -| `_grantee_contains?` | `string` \| ``null`` | -| `_grantee_in?` | `string`[] | -| `_grantee_not?` | `string` \| ``null`` | -| `_grantee_not_contains?` | `string` \| ``null`` | -| `_grantee_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:20 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | `string` | -| `_conditionId` | `string` | -| `_documentId` | `string` | -| `_grantee` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:54 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:99 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:95 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:73 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:91 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:9 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:136 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:131 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:104 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:126 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:1 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTAccessCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTAccessCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.NFTAccessCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTAccessCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:71 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTAccessCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTAccessCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.NFTAccessCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.NFTAccessCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.NFTAccessCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTAccessCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:72 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFTAccessCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:102 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFTAccessCondition.md#initializedfilter), [`InitializedResult`](subgraphs.NFTAccessCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFTAccessCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:103 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTAccessCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:139 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFTAccessCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFTAccessCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTAccessCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:140 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTAccessProofTemplate.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTAccessProofTemplate.md deleted file mode 100644 index a7e5e19c05..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTAccessProofTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NFTAccessProofTemplate - -# Namespace: NFTAccessProofTemplate - -[subgraphs](subgraphs.md).NFTAccessProofTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFTAccessProofTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFTAccessProofTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFTAccessProofTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFTAccessProofTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFTAccessProofTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFTAccessProofTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFTAccessProofTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFTAccessProofTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFTAccessProofTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFTAccessProofTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFTAccessProofTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFTAccessProofTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFTAccessProofTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFTAccessProofTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFTAccessProofTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFTAccessProofTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:117 - -___ - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | ``true`` | -| `_accessProvider` | ``true`` | -| `_agreementId` | ``true`` | -| `_conditionIdSeeds` | ``true`` | -| `_conditionIds` | ``true`` | -| `_creator` | ``true`` | -| `_did` | ``true`` | -| `_idSeed` | ``true`` | -| `_timeLocks` | ``true`` | -| `_timeOuts` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:104 - -___ - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer?` | `string` \| ``null`` | -| `_accessConsumer_contains?` | `string` \| ``null`` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| ``null`` | -| `_accessConsumer_not_contains?` | `string` \| ``null`` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| ``null`` | -| `_accessProvider_contains?` | `string` \| ``null`` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| ``null`` | -| `_accessProvider_not_contains?` | `string` \| ``null`` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| ``null`` | -| `_creator_contains?` | `string` \| ``null`` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| ``null`` | -| `_creator_not_contains?` | `string` \| ``null`` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| ``null`` | -| `_idSeed_contains?` | `string` \| ``null`` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| ``null`` | -| `_idSeed_not_contains?` | `string` \| ``null`` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:21 - -___ - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| ``null``)[] | -| `_conditionIds` | (`string` \| ``null``)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| ``null``)[] | -| `_timeOuts` | (`Wei` \| ``null``)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:91 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessProofTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:148 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:144 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:122 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:140 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:185 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:180 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:153 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:175 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessProofTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:120 - -___ - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessProofTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:121 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessProofTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessProofTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessProofTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFTAccessProofTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessProofTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:151 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessProofTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessProofTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessProofTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFTAccessProofTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFTAccessProofTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFTAccessProofTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessProofTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:152 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessProofTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:188 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessProofTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:189 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTAccessSwapTemplate.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTAccessSwapTemplate.md deleted file mode 100644 index 0815ba3705..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTAccessSwapTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NFTAccessSwapTemplate - -# Namespace: NFTAccessSwapTemplate - -[subgraphs](subgraphs.md).NFTAccessSwapTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFTAccessSwapTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFTAccessSwapTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFTAccessSwapTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFTAccessSwapTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFTAccessSwapTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFTAccessSwapTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFTAccessSwapTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFTAccessSwapTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFTAccessSwapTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFTAccessSwapTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFTAccessSwapTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFTAccessSwapTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:117 - -___ - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | ``true`` | -| `_accessProvider` | ``true`` | -| `_agreementId` | ``true`` | -| `_conditionIdSeeds` | ``true`` | -| `_conditionIds` | ``true`` | -| `_creator` | ``true`` | -| `_did` | ``true`` | -| `_idSeed` | ``true`` | -| `_timeLocks` | ``true`` | -| `_timeOuts` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:104 - -___ - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer?` | `string` \| ``null`` | -| `_accessConsumer_contains?` | `string` \| ``null`` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| ``null`` | -| `_accessConsumer_not_contains?` | `string` \| ``null`` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| ``null`` | -| `_accessProvider_contains?` | `string` \| ``null`` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| ``null`` | -| `_accessProvider_not_contains?` | `string` \| ``null`` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| ``null`` | -| `_creator_contains?` | `string` \| ``null`` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| ``null`` | -| `_creator_not_contains?` | `string` \| ``null`` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| ``null`` | -| `_idSeed_contains?` | `string` \| ``null`` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| ``null`` | -| `_idSeed_not_contains?` | `string` \| ``null`` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:21 - -___ - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| ``null``)[] | -| `_conditionIds` | (`string` \| ``null``)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| ``null``)[] | -| `_timeOuts` | (`Wei` \| ``null``)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:91 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessSwapTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:148 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:144 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:122 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:140 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:185 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:180 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:153 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:175 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessSwapTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:120 - -___ - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessSwapTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:121 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessSwapTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessSwapTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessSwapTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFTAccessSwapTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessSwapTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:151 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessSwapTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessSwapTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessSwapTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFTAccessSwapTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFTAccessSwapTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFTAccessSwapTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessSwapTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:152 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessSwapTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:188 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessSwapTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:189 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTAccessTemplate.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTAccessTemplate.md deleted file mode 100644 index 1236fd4951..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTAccessTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NFTAccessTemplate - -# Namespace: NFTAccessTemplate - -[subgraphs](subgraphs.md).NFTAccessTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFTAccessTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFTAccessTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFTAccessTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFTAccessTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFTAccessTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFTAccessTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFTAccessTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFTAccessTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFTAccessTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFTAccessTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFTAccessTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFTAccessTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFTAccessTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFTAccessTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFTAccessTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFTAccessTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFTAccessTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFTAccessTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFTAccessTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFTAccessTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTAccessTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:117 - -___ - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | ``true`` | -| `_accessProvider` | ``true`` | -| `_agreementId` | ``true`` | -| `_conditionIdSeeds` | ``true`` | -| `_conditionIds` | ``true`` | -| `_creator` | ``true`` | -| `_did` | ``true`` | -| `_idSeed` | ``true`` | -| `_timeLocks` | ``true`` | -| `_timeOuts` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:104 - -___ - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer?` | `string` \| ``null`` | -| `_accessConsumer_contains?` | `string` \| ``null`` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| ``null`` | -| `_accessConsumer_not_contains?` | `string` \| ``null`` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| ``null`` | -| `_accessProvider_contains?` | `string` \| ``null`` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| ``null`` | -| `_accessProvider_not_contains?` | `string` \| ``null`` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| ``null`` | -| `_creator_contains?` | `string` \| ``null`` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| ``null`` | -| `_creator_not_contains?` | `string` \| ``null`` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| ``null`` | -| `_idSeed_contains?` | `string` \| ``null`` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| ``null`` | -| `_idSeed_not_contains?` | `string` \| ``null`` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:21 - -___ - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| ``null``)[] | -| `_conditionIds` | (`string` \| ``null``)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| ``null``)[] | -| `_timeOuts` | (`Wei` \| ``null``)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:91 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:148 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:144 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:122 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:140 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:185 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:180 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:153 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:175 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTAccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTAccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:120 - -___ - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTAccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFTAccessTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFTAccessTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTAccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:121 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFTAccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:151 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFTAccessTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFTAccessTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFTAccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:152 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTAccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:188 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFTAccessTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFTAccessTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTAccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:189 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTEscrowPaymentCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTEscrowPaymentCondition.md deleted file mode 100644 index e96a3f1a55..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTEscrowPaymentCondition.md +++ /dev/null @@ -1,685 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NFTEscrowPaymentCondition - -# Namespace: NFTEscrowPaymentCondition - -[subgraphs](subgraphs.md).NFTEscrowPaymentCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.NFTEscrowPaymentCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.NFTEscrowPaymentCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.NFTEscrowPaymentCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.NFTEscrowPaymentCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.NFTEscrowPaymentCondition.md#initializedargs) -- [InitializedFields](subgraphs.NFTEscrowPaymentCondition.md#initializedfields) -- [InitializedFilter](subgraphs.NFTEscrowPaymentCondition.md#initializedfilter) -- [InitializedResult](subgraphs.NFTEscrowPaymentCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFTEscrowPaymentCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredresult) -- [ReceivedArgs](subgraphs.NFTEscrowPaymentCondition.md#receivedargs) -- [ReceivedFields](subgraphs.NFTEscrowPaymentCondition.md#receivedfields) -- [ReceivedFilter](subgraphs.NFTEscrowPaymentCondition.md#receivedfilter) -- [ReceivedResult](subgraphs.NFTEscrowPaymentCondition.md#receivedresult) -- [SingleQueryOptions](subgraphs.NFTEscrowPaymentCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.NFTEscrowPaymentCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.NFTEscrowPaymentCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.NFTEscrowPaymentCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFTEscrowPaymentCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFTEscrowPaymentCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFTEscrowPaymentCondition.md#getownershiptransferreds) -- [getReceivedById](subgraphs.NFTEscrowPaymentCondition.md#getreceivedbyid) -- [getReceiveds](subgraphs.NFTEscrowPaymentCondition.md#getreceiveds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:87 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | ``true`` | -| `_amounts` | ``true`` | -| `_conditionId` | ``true`` | -| `_did` | ``true`` | -| `_receivers` | ``true`` | -| `_tokenAddress` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:78 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_amounts?` | `WeiSource` \| ``null`` | -| `_amounts_gt?` | `WeiSource` \| ``null`` | -| `_amounts_gte?` | `WeiSource` \| ``null`` | -| `_amounts_in?` | `WeiSource`[] | -| `_amounts_lt?` | `WeiSource` \| ``null`` | -| `_amounts_lte?` | `WeiSource` \| ``null`` | -| `_amounts_not?` | `WeiSource` \| ``null`` | -| `_amounts_not_in?` | `WeiSource`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_receivers?` | `string` \| ``null`` | -| `_receivers_contains?` | `string` \| ``null`` | -| `_receivers_in?` | `string`[] | -| `_receivers_not?` | `string` \| ``null`` | -| `_receivers_not_contains?` | `string` \| ``null`` | -| `_receivers_not_in?` | `string`[] | -| `_tokenAddress?` | `string` \| ``null`` | -| `_tokenAddress_contains?` | `string` \| ``null`` | -| `_tokenAddress_in?` | `string`[] | -| `_tokenAddress_not?` | `string` \| ``null`` | -| `_tokenAddress_not_contains?` | `string` \| ``null`` | -| `_tokenAddress_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:21 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | `string` | -| `_amounts` | `Wei` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `_receivers` | `string` | -| `_tokenAddress` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:69 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTEscrowPaymentCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:118 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:114 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:92 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:110 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:155 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:150 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:123 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:145 - -___ - -### ReceivedArgs - -Ƭ **ReceivedArgs**<`K`\>: { [Property in keyof Pick]: ReceivedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ReceivedResult`](subgraphs.NFTEscrowPaymentCondition.md#receivedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:194 - -___ - -### ReceivedFields - -Ƭ **ReceivedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_from` | ``true`` | -| `_value` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:189 - -___ - -### ReceivedFilter - -Ƭ **ReceivedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_from?` | `string` \| ``null`` | -| `_from_contains?` | `string` \| ``null`` | -| `_from_in?` | `string`[] | -| `_from_not?` | `string` \| ``null`` | -| `_from_not_contains?` | `string` \| ``null`` | -| `_from_not_in?` | `string`[] | -| `_value?` | `WeiSource` \| ``null`` | -| `_value_gt?` | `WeiSource` \| ``null`` | -| `_value_gte?` | `WeiSource` \| ``null`` | -| `_value_in?` | `WeiSource`[] | -| `_value_lt?` | `WeiSource` \| ``null`` | -| `_value_lte?` | `WeiSource` \| ``null`` | -| `_value_not?` | `WeiSource` \| ``null`` | -| `_value_not_in?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:160 - -___ - -### ReceivedResult - -Ƭ **ReceivedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_from` | `string` | -| `_value` | `Wei` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:184 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTEscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:90 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTEscrowPaymentCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:91 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTEscrowPaymentCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTEscrowPaymentCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTEscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFTEscrowPaymentCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTEscrowPaymentCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:121 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTEscrowPaymentCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTEscrowPaymentCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTEscrowPaymentCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFTEscrowPaymentCondition.md#initializedfilter), [`InitializedResult`](subgraphs.NFTEscrowPaymentCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFTEscrowPaymentCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTEscrowPaymentCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:122 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTEscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:158 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTEscrowPaymentCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:159 - -___ - -### getReceivedById - -▸ **getReceivedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ReceivedResult`](subgraphs.NFTEscrowPaymentCondition.md#receivedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ReceivedResult`](subgraphs.NFTEscrowPaymentCondition.md#receivedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTEscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`ReceivedArgs`](subgraphs.NFTEscrowPaymentCondition.md#receivedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ReceivedResult`](subgraphs.NFTEscrowPaymentCondition.md#receivedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:197 - -___ - -### getReceiveds - -▸ **getReceiveds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ReceivedResult`](subgraphs.NFTEscrowPaymentCondition.md#receivedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ReceivedResult`](subgraphs.NFTEscrowPaymentCondition.md#receivedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTEscrowPaymentCondition.md#multiqueryoptions)<[`ReceivedFilter`](subgraphs.NFTEscrowPaymentCondition.md#receivedfilter), [`ReceivedResult`](subgraphs.NFTEscrowPaymentCondition.md#receivedresult)\> | -| `args` | [`ReceivedArgs`](subgraphs.NFTEscrowPaymentCondition.md#receivedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ReceivedResult`](subgraphs.NFTEscrowPaymentCondition.md#receivedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:198 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTHolderCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTHolderCondition.md deleted file mode 100644 index 4008d5fe90..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTHolderCondition.md +++ /dev/null @@ -1,526 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NFTHolderCondition - -# Namespace: NFTHolderCondition - -[subgraphs](subgraphs.md).NFTHolderCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.NFTHolderCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.NFTHolderCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.NFTHolderCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.NFTHolderCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.NFTHolderCondition.md#initializedargs) -- [InitializedFields](subgraphs.NFTHolderCondition.md#initializedfields) -- [InitializedFilter](subgraphs.NFTHolderCondition.md#initializedfilter) -- [InitializedResult](subgraphs.NFTHolderCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFTHolderCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFTHolderCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFTHolderCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFTHolderCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFTHolderCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFTHolderCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.NFTHolderCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.NFTHolderCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.NFTHolderCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFTHolderCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFTHolderCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFTHolderCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTHolderCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:79 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_address` | ``true`` | -| `_agreementId` | ``true`` | -| `_amount` | ``true`` | -| `_conditionId` | ``true`` | -| `_did` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:71 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_address?` | `string` \| ``null`` | -| `_address_contains?` | `string` \| ``null`` | -| `_address_in?` | `string`[] | -| `_address_not?` | `string` \| ``null`` | -| `_address_not_contains?` | `string` \| ``null`` | -| `_address_not_in?` | `string`[] | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_amount?` | `WeiSource` \| ``null`` | -| `_amount_gt?` | `WeiSource` \| ``null`` | -| `_amount_gte?` | `WeiSource` \| ``null`` | -| `_amount_in?` | `WeiSource`[] | -| `_amount_lt?` | `WeiSource` \| ``null`` | -| `_amount_lte?` | `WeiSource` \| ``null`` | -| `_amount_not?` | `WeiSource` \| ``null`` | -| `_amount_not_in?` | `WeiSource`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:21 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_address` | `string` | -| `_agreementId` | `string` | -| `_amount` | `Wei` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:63 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTHolderCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:110 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:106 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:84 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:102 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTHolderCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:147 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:142 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:115 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:137 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTHolderCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTHolderCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTHolderCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.NFTHolderCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTHolderCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:82 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTHolderCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTHolderCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTHolderCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.NFTHolderCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.NFTHolderCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.NFTHolderCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTHolderCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:83 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTHolderCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTHolderCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTHolderCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFTHolderCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTHolderCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:113 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTHolderCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTHolderCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTHolderCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFTHolderCondition.md#initializedfilter), [`InitializedResult`](subgraphs.NFTHolderCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFTHolderCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTHolderCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:114 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTHolderCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTHolderCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTHolderCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTHolderCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTHolderCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:150 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTHolderCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTHolderCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTHolderCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFTHolderCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFTHolderCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTHolderCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTHolderCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:151 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTLockCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTLockCondition.md deleted file mode 100644 index cf4357a796..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTLockCondition.md +++ /dev/null @@ -1,542 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NFTLockCondition - -# Namespace: NFTLockCondition - -[subgraphs](subgraphs.md).NFTLockCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.NFTLockCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.NFTLockCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.NFTLockCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.NFTLockCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.NFTLockCondition.md#initializedargs) -- [InitializedFields](subgraphs.NFTLockCondition.md#initializedfields) -- [InitializedFilter](subgraphs.NFTLockCondition.md#initializedfilter) -- [InitializedResult](subgraphs.NFTLockCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFTLockCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFTLockCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFTLockCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFTLockCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFTLockCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFTLockCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.NFTLockCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.NFTLockCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.NFTLockCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFTLockCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFTLockCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFTLockCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTLockCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:95 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | ``true`` | -| `_amount` | ``true`` | -| `_conditionId` | ``true`` | -| `_did` | ``true`` | -| `_lockAddress` | ``true`` | -| `_nftContractAddress` | ``true`` | -| `_receiver` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:85 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_amount?` | `WeiSource` \| ``null`` | -| `_amount_gt?` | `WeiSource` \| ``null`` | -| `_amount_gte?` | `WeiSource` \| ``null`` | -| `_amount_in?` | `WeiSource`[] | -| `_amount_lt?` | `WeiSource` \| ``null`` | -| `_amount_lte?` | `WeiSource` \| ``null`` | -| `_amount_not?` | `WeiSource` \| ``null`` | -| `_amount_not_in?` | `WeiSource`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_lockAddress?` | `string` \| ``null`` | -| `_lockAddress_contains?` | `string` \| ``null`` | -| `_lockAddress_in?` | `string`[] | -| `_lockAddress_not?` | `string` \| ``null`` | -| `_lockAddress_not_contains?` | `string` \| ``null`` | -| `_lockAddress_not_in?` | `string`[] | -| `_nftContractAddress?` | `string` \| ``null`` | -| `_nftContractAddress_contains?` | `string` \| ``null`` | -| `_nftContractAddress_in?` | `string`[] | -| `_nftContractAddress_not?` | `string` \| ``null`` | -| `_nftContractAddress_not_contains?` | `string` \| ``null`` | -| `_nftContractAddress_not_in?` | `string`[] | -| `_receiver?` | `string` \| ``null`` | -| `_receiver_contains?` | `string` \| ``null`` | -| `_receiver_in?` | `string`[] | -| `_receiver_not?` | `string` \| ``null`` | -| `_receiver_not_contains?` | `string` \| ``null`` | -| `_receiver_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:21 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | `string` | -| `_amount` | `Wei` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `_lockAddress` | `string` | -| `_nftContractAddress` | `string` | -| `_receiver` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:75 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTLockCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:126 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:122 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:100 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:118 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTLockCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:163 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:158 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:131 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:153 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTLockCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTLockCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTLockCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.NFTLockCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTLockCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:98 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTLockCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTLockCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTLockCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.NFTLockCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.NFTLockCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.NFTLockCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTLockCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:99 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTLockCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTLockCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTLockCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFTLockCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTLockCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:129 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTLockCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTLockCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTLockCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFTLockCondition.md#initializedfilter), [`InitializedResult`](subgraphs.NFTLockCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFTLockCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTLockCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:130 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTLockCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTLockCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTLockCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTLockCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTLockCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:166 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTLockCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTLockCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTLockCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFTLockCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFTLockCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTLockCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTLockCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:167 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTSalesTemplate.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTSalesTemplate.md deleted file mode 100644 index 12ebe8a93e..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTSalesTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NFTSalesTemplate - -# Namespace: NFTSalesTemplate - -[subgraphs](subgraphs.md).NFTSalesTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFTSalesTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFTSalesTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFTSalesTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFTSalesTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFTSalesTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFTSalesTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFTSalesTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFTSalesTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFTSalesTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFTSalesTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFTSalesTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFTSalesTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFTSalesTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFTSalesTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFTSalesTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFTSalesTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFTSalesTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFTSalesTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFTSalesTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFTSalesTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTSalesTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:117 - -___ - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | ``true`` | -| `_accessProvider` | ``true`` | -| `_agreementId` | ``true`` | -| `_conditionIdSeeds` | ``true`` | -| `_conditionIds` | ``true`` | -| `_creator` | ``true`` | -| `_did` | ``true`` | -| `_idSeed` | ``true`` | -| `_timeLocks` | ``true`` | -| `_timeOuts` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:104 - -___ - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer?` | `string` \| ``null`` | -| `_accessConsumer_contains?` | `string` \| ``null`` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| ``null`` | -| `_accessConsumer_not_contains?` | `string` \| ``null`` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| ``null`` | -| `_accessProvider_contains?` | `string` \| ``null`` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| ``null`` | -| `_accessProvider_not_contains?` | `string` \| ``null`` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| ``null`` | -| `_creator_contains?` | `string` \| ``null`` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| ``null`` | -| `_creator_not_contains?` | `string` \| ``null`` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| ``null`` | -| `_idSeed_contains?` | `string` \| ``null`` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| ``null`` | -| `_idSeed_not_contains?` | `string` \| ``null`` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:21 - -___ - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| ``null``)[] | -| `_conditionIds` | (`string` \| ``null``)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| ``null``)[] | -| `_timeOuts` | (`Wei` \| ``null``)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:91 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTSalesTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:148 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:144 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:122 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:140 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTSalesTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:185 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:180 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:153 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:175 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTSalesTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTSalesTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTSalesTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTSalesTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTSalesTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:120 - -___ - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTSalesTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTSalesTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTSalesTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFTSalesTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFTSalesTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTSalesTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTSalesTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:121 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTSalesTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTSalesTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTSalesTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFTSalesTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTSalesTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:151 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTSalesTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTSalesTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTSalesTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFTSalesTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFTSalesTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFTSalesTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTSalesTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:152 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTSalesTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTSalesTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTSalesTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTSalesTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTSalesTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:188 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTSalesTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTSalesTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTSalesTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFTSalesTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFTSalesTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTSalesTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTSalesTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:189 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTSalesWithAccessTemplate.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTSalesWithAccessTemplate.md deleted file mode 100644 index 86d89053b2..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NFTSalesWithAccessTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NFTSalesWithAccessTemplate - -# Namespace: NFTSalesWithAccessTemplate - -[subgraphs](subgraphs.md).NFTSalesWithAccessTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFTSalesWithAccessTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFTSalesWithAccessTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFTSalesWithAccessTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFTSalesWithAccessTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFTSalesWithAccessTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFTSalesWithAccessTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFTSalesWithAccessTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFTSalesWithAccessTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFTSalesWithAccessTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFTSalesWithAccessTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFTSalesWithAccessTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFTSalesWithAccessTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:117 - -___ - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | ``true`` | -| `_accessProvider` | ``true`` | -| `_agreementId` | ``true`` | -| `_conditionIdSeeds` | ``true`` | -| `_conditionIds` | ``true`` | -| `_creator` | ``true`` | -| `_did` | ``true`` | -| `_idSeed` | ``true`` | -| `_timeLocks` | ``true`` | -| `_timeOuts` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:104 - -___ - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer?` | `string` \| ``null`` | -| `_accessConsumer_contains?` | `string` \| ``null`` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| ``null`` | -| `_accessConsumer_not_contains?` | `string` \| ``null`` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| ``null`` | -| `_accessProvider_contains?` | `string` \| ``null`` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| ``null`` | -| `_accessProvider_not_contains?` | `string` \| ``null`` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| ``null`` | -| `_creator_contains?` | `string` \| ``null`` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| ``null`` | -| `_creator_not_contains?` | `string` \| ``null`` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| ``null`` | -| `_idSeed_contains?` | `string` \| ``null`` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| ``null`` | -| `_idSeed_not_contains?` | `string` \| ``null`` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:21 - -___ - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| ``null``)[] | -| `_conditionIds` | (`string` \| ``null``)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| ``null``)[] | -| `_timeOuts` | (`Wei` \| ``null``)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:91 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTSalesWithAccessTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:148 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:144 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:122 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:140 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:185 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:180 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:153 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:175 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTSalesWithAccessTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:120 - -___ - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTSalesWithAccessTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:121 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTSalesWithAccessTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTSalesWithAccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTSalesWithAccessTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFTSalesWithAccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTSalesWithAccessTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:151 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTSalesWithAccessTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTSalesWithAccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTSalesWithAccessTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFTSalesWithAccessTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFTSalesWithAccessTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFTSalesWithAccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTSalesWithAccessTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:152 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTSalesWithAccessTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:188 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTSalesWithAccessTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:189 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NeverminedConfig.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NeverminedConfig.md deleted file mode 100644 index 4901dc0abc..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NeverminedConfig.md +++ /dev/null @@ -1,971 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NeverminedConfig - -# Namespace: NeverminedConfig - -[subgraphs](subgraphs.md).NeverminedConfig - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.NeverminedConfig.md#initializedargs) -- [InitializedFields](subgraphs.NeverminedConfig.md#initializedfields) -- [InitializedFilter](subgraphs.NeverminedConfig.md#initializedfilter) -- [InitializedResult](subgraphs.NeverminedConfig.md#initializedresult) -- [MultiQueryOptions](subgraphs.NeverminedConfig.md#multiqueryoptions) -- [NeverminedConfigChangeArgs](subgraphs.NeverminedConfig.md#neverminedconfigchangeargs) -- [NeverminedConfigChangeFields](subgraphs.NeverminedConfig.md#neverminedconfigchangefields) -- [NeverminedConfigChangeFilter](subgraphs.NeverminedConfig.md#neverminedconfigchangefilter) -- [NeverminedConfigChangeResult](subgraphs.NeverminedConfig.md#neverminedconfigchangeresult) -- [OwnershipTransferredArgs](subgraphs.NeverminedConfig.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NeverminedConfig.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NeverminedConfig.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NeverminedConfig.md#ownershiptransferredresult) -- [RoleAdminChangedArgs](subgraphs.NeverminedConfig.md#roleadminchangedargs) -- [RoleAdminChangedFields](subgraphs.NeverminedConfig.md#roleadminchangedfields) -- [RoleAdminChangedFilter](subgraphs.NeverminedConfig.md#roleadminchangedfilter) -- [RoleAdminChangedResult](subgraphs.NeverminedConfig.md#roleadminchangedresult) -- [RoleGrantedArgs](subgraphs.NeverminedConfig.md#rolegrantedargs) -- [RoleGrantedFields](subgraphs.NeverminedConfig.md#rolegrantedfields) -- [RoleGrantedFilter](subgraphs.NeverminedConfig.md#rolegrantedfilter) -- [RoleGrantedResult](subgraphs.NeverminedConfig.md#rolegrantedresult) -- [RoleRevokedArgs](subgraphs.NeverminedConfig.md#rolerevokedargs) -- [RoleRevokedFields](subgraphs.NeverminedConfig.md#rolerevokedfields) -- [RoleRevokedFilter](subgraphs.NeverminedConfig.md#rolerevokedfilter) -- [RoleRevokedResult](subgraphs.NeverminedConfig.md#rolerevokedresult) -- [SingleQueryOptions](subgraphs.NeverminedConfig.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.NeverminedConfig.md#getinitializedbyid) -- [getInitializeds](subgraphs.NeverminedConfig.md#getinitializeds) -- [getNeverminedConfigChangeById](subgraphs.NeverminedConfig.md#getneverminedconfigchangebyid) -- [getNeverminedConfigChanges](subgraphs.NeverminedConfig.md#getneverminedconfigchanges) -- [getOwnershipTransferredById](subgraphs.NeverminedConfig.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NeverminedConfig.md#getownershiptransferreds) -- [getRoleAdminChangedById](subgraphs.NeverminedConfig.md#getroleadminchangedbyid) -- [getRoleAdminChangeds](subgraphs.NeverminedConfig.md#getroleadminchangeds) -- [getRoleGrantedById](subgraphs.NeverminedConfig.md#getrolegrantedbyid) -- [getRoleGranteds](subgraphs.NeverminedConfig.md#getrolegranteds) -- [getRoleRevokedById](subgraphs.NeverminedConfig.md#getrolerevokedbyid) -- [getRoleRevokeds](subgraphs.NeverminedConfig.md#getrolerevokeds) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NeverminedConfig.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:46 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:42 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:20 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:38 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:9 - -___ - -### NeverminedConfigChangeArgs - -Ƭ **NeverminedConfigChangeArgs**<`K`\>: { [Property in keyof Pick]: NeverminedConfigChangeFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`NeverminedConfigChangeResult`](subgraphs.NeverminedConfig.md#neverminedconfigchangeresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:83 - -___ - -### NeverminedConfigChangeFields - -Ƭ **NeverminedConfigChangeFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_parameter` | ``true`` | -| `_whoChanged` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:78 - -___ - -### NeverminedConfigChangeFilter - -Ƭ **NeverminedConfigChangeFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_parameter?` | `string` \| ``null`` | -| `_parameter_contains?` | `string` \| ``null`` | -| `_parameter_in?` | `string`[] | -| `_parameter_not?` | `string` \| ``null`` | -| `_parameter_not_contains?` | `string` \| ``null`` | -| `_parameter_not_in?` | `string`[] | -| `_whoChanged?` | `string` \| ``null`` | -| `_whoChanged_contains?` | `string` \| ``null`` | -| `_whoChanged_in?` | `string`[] | -| `_whoChanged_not?` | `string` \| ``null`` | -| `_whoChanged_not_contains?` | `string` \| ``null`` | -| `_whoChanged_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:51 - -___ - -### NeverminedConfigChangeResult - -Ƭ **NeverminedConfigChangeResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_parameter` | `string` | -| `_whoChanged` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:73 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NeverminedConfig.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:120 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:115 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:88 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:110 - -___ - -### RoleAdminChangedArgs - -Ƭ **RoleAdminChangedArgs**<`K`\>: { [Property in keyof Pick]: RoleAdminChangedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.NeverminedConfig.md#roleadminchangedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:165 - -___ - -### RoleAdminChangedFields - -Ƭ **RoleAdminChangedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newAdminRole` | ``true`` | -| `previousAdminRole` | ``true`` | -| `role` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:159 - -___ - -### RoleAdminChangedFilter - -Ƭ **RoleAdminChangedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newAdminRole?` | `string` \| ``null`` | -| `newAdminRole_contains?` | `string` \| ``null`` | -| `newAdminRole_in?` | `string`[] | -| `newAdminRole_not?` | `string` \| ``null`` | -| `newAdminRole_not_contains?` | `string` \| ``null`` | -| `newAdminRole_not_in?` | `string`[] | -| `previousAdminRole?` | `string` \| ``null`` | -| `previousAdminRole_contains?` | `string` \| ``null`` | -| `previousAdminRole_in?` | `string`[] | -| `previousAdminRole_not?` | `string` \| ``null`` | -| `previousAdminRole_not_contains?` | `string` \| ``null`` | -| `previousAdminRole_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:125 - -___ - -### RoleAdminChangedResult - -Ƭ **RoleAdminChangedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newAdminRole` | `string` | -| `previousAdminRole` | `string` | -| `role` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:153 - -___ - -### RoleGrantedArgs - -Ƭ **RoleGrantedArgs**<`K`\>: { [Property in keyof Pick]: RoleGrantedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.NeverminedConfig.md#rolegrantedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:210 - -___ - -### RoleGrantedFields - -Ƭ **RoleGrantedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | ``true`` | -| `id` | ``true`` | -| `role` | ``true`` | -| `sender` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:204 - -___ - -### RoleGrantedFilter - -Ƭ **RoleGrantedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account?` | `string` \| ``null`` | -| `account_contains?` | `string` \| ``null`` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| ``null`` | -| `account_not_contains?` | `string` \| ``null`` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| ``null`` | -| `sender_contains?` | `string` \| ``null`` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| ``null`` | -| `sender_not_contains?` | `string` \| ``null`` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:170 - -___ - -### RoleGrantedResult - -Ƭ **RoleGrantedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:198 - -___ - -### RoleRevokedArgs - -Ƭ **RoleRevokedArgs**<`K`\>: { [Property in keyof Pick]: RoleRevokedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.NeverminedConfig.md#rolerevokedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:255 - -___ - -### RoleRevokedFields - -Ƭ **RoleRevokedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | ``true`` | -| `id` | ``true`` | -| `role` | ``true`` | -| `sender` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:249 - -___ - -### RoleRevokedFilter - -Ƭ **RoleRevokedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account?` | `string` \| ``null`` | -| `account_contains?` | `string` \| ``null`` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| ``null`` | -| `account_not_contains?` | `string` \| ``null`` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| ``null`` | -| `sender_contains?` | `string` \| ``null`` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| ``null`` | -| `sender_not_contains?` | `string` \| ``null`` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:215 - -___ - -### RoleRevokedResult - -Ƭ **RoleRevokedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:243 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:1 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NeverminedConfig.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NeverminedConfig.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedConfig.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NeverminedConfig.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NeverminedConfig.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:49 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NeverminedConfig.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NeverminedConfig.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedConfig.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NeverminedConfig.md#initializedfilter), [`InitializedResult`](subgraphs.NeverminedConfig.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NeverminedConfig.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NeverminedConfig.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:50 - -___ - -### getNeverminedConfigChangeById - -▸ **getNeverminedConfigChangeById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`NeverminedConfigChangeResult`](subgraphs.NeverminedConfig.md#neverminedconfigchangeresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`NeverminedConfigChangeResult`](subgraphs.NeverminedConfig.md#neverminedconfigchangeresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedConfig.md#singlequeryoptions) | -| `args` | [`NeverminedConfigChangeArgs`](subgraphs.NeverminedConfig.md#neverminedconfigchangeargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`NeverminedConfigChangeResult`](subgraphs.NeverminedConfig.md#neverminedconfigchangeresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:86 - -___ - -### getNeverminedConfigChanges - -▸ **getNeverminedConfigChanges**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`NeverminedConfigChangeResult`](subgraphs.NeverminedConfig.md#neverminedconfigchangeresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`NeverminedConfigChangeResult`](subgraphs.NeverminedConfig.md#neverminedconfigchangeresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedConfig.md#multiqueryoptions)<[`NeverminedConfigChangeFilter`](subgraphs.NeverminedConfig.md#neverminedconfigchangefilter), [`NeverminedConfigChangeResult`](subgraphs.NeverminedConfig.md#neverminedconfigchangeresult)\> | -| `args` | [`NeverminedConfigChangeArgs`](subgraphs.NeverminedConfig.md#neverminedconfigchangeargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`NeverminedConfigChangeResult`](subgraphs.NeverminedConfig.md#neverminedconfigchangeresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:87 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NeverminedConfig.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NeverminedConfig.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedConfig.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NeverminedConfig.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NeverminedConfig.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:123 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NeverminedConfig.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NeverminedConfig.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedConfig.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NeverminedConfig.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NeverminedConfig.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NeverminedConfig.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NeverminedConfig.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:124 - -___ - -### getRoleAdminChangedById - -▸ **getRoleAdminChangedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NeverminedConfig.md#roleadminchangedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.NeverminedConfig.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedConfig.md#singlequeryoptions) | -| `args` | [`RoleAdminChangedArgs`](subgraphs.NeverminedConfig.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NeverminedConfig.md#roleadminchangedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:168 - -___ - -### getRoleAdminChangeds - -▸ **getRoleAdminChangeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NeverminedConfig.md#roleadminchangedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.NeverminedConfig.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedConfig.md#multiqueryoptions)<[`RoleAdminChangedFilter`](subgraphs.NeverminedConfig.md#roleadminchangedfilter), [`RoleAdminChangedResult`](subgraphs.NeverminedConfig.md#roleadminchangedresult)\> | -| `args` | [`RoleAdminChangedArgs`](subgraphs.NeverminedConfig.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NeverminedConfig.md#roleadminchangedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:169 - -___ - -### getRoleGrantedById - -▸ **getRoleGrantedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NeverminedConfig.md#rolegrantedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.NeverminedConfig.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedConfig.md#singlequeryoptions) | -| `args` | [`RoleGrantedArgs`](subgraphs.NeverminedConfig.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NeverminedConfig.md#rolegrantedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:213 - -___ - -### getRoleGranteds - -▸ **getRoleGranteds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NeverminedConfig.md#rolegrantedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.NeverminedConfig.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedConfig.md#multiqueryoptions)<[`RoleGrantedFilter`](subgraphs.NeverminedConfig.md#rolegrantedfilter), [`RoleGrantedResult`](subgraphs.NeverminedConfig.md#rolegrantedresult)\> | -| `args` | [`RoleGrantedArgs`](subgraphs.NeverminedConfig.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NeverminedConfig.md#rolegrantedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:214 - -___ - -### getRoleRevokedById - -▸ **getRoleRevokedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NeverminedConfig.md#rolerevokedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.NeverminedConfig.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedConfig.md#singlequeryoptions) | -| `args` | [`RoleRevokedArgs`](subgraphs.NeverminedConfig.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NeverminedConfig.md#rolerevokedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:258 - -___ - -### getRoleRevokeds - -▸ **getRoleRevokeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NeverminedConfig.md#rolerevokedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.NeverminedConfig.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedConfig.md#multiqueryoptions)<[`RoleRevokedFilter`](subgraphs.NeverminedConfig.md#rolerevokedfilter), [`RoleRevokedResult`](subgraphs.NeverminedConfig.md#rolerevokedresult)\> | -| `args` | [`RoleRevokedArgs`](subgraphs.NeverminedConfig.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NeverminedConfig.md#rolerevokedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:259 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.NeverminedToken.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.NeverminedToken.md deleted file mode 100644 index 005294d37e..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.NeverminedToken.md +++ /dev/null @@ -1,1140 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / NeverminedToken - -# Namespace: NeverminedToken - -[subgraphs](subgraphs.md).NeverminedToken - -## Table of contents - -### Type Aliases - -- [ApprovalArgs](subgraphs.NeverminedToken.md#approvalargs) -- [ApprovalFields](subgraphs.NeverminedToken.md#approvalfields) -- [ApprovalFilter](subgraphs.NeverminedToken.md#approvalfilter) -- [ApprovalResult](subgraphs.NeverminedToken.md#approvalresult) -- [InitializedArgs](subgraphs.NeverminedToken.md#initializedargs) -- [InitializedFields](subgraphs.NeverminedToken.md#initializedfields) -- [InitializedFilter](subgraphs.NeverminedToken.md#initializedfilter) -- [InitializedResult](subgraphs.NeverminedToken.md#initializedresult) -- [MultiQueryOptions](subgraphs.NeverminedToken.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NeverminedToken.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NeverminedToken.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NeverminedToken.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NeverminedToken.md#ownershiptransferredresult) -- [RoleAdminChangedArgs](subgraphs.NeverminedToken.md#roleadminchangedargs) -- [RoleAdminChangedFields](subgraphs.NeverminedToken.md#roleadminchangedfields) -- [RoleAdminChangedFilter](subgraphs.NeverminedToken.md#roleadminchangedfilter) -- [RoleAdminChangedResult](subgraphs.NeverminedToken.md#roleadminchangedresult) -- [RoleGrantedArgs](subgraphs.NeverminedToken.md#rolegrantedargs) -- [RoleGrantedFields](subgraphs.NeverminedToken.md#rolegrantedfields) -- [RoleGrantedFilter](subgraphs.NeverminedToken.md#rolegrantedfilter) -- [RoleGrantedResult](subgraphs.NeverminedToken.md#rolegrantedresult) -- [RoleRevokedArgs](subgraphs.NeverminedToken.md#rolerevokedargs) -- [RoleRevokedFields](subgraphs.NeverminedToken.md#rolerevokedfields) -- [RoleRevokedFilter](subgraphs.NeverminedToken.md#rolerevokedfilter) -- [RoleRevokedResult](subgraphs.NeverminedToken.md#rolerevokedresult) -- [SingleQueryOptions](subgraphs.NeverminedToken.md#singlequeryoptions) -- [TransferArgs](subgraphs.NeverminedToken.md#transferargs) -- [TransferFields](subgraphs.NeverminedToken.md#transferfields) -- [TransferFilter](subgraphs.NeverminedToken.md#transferfilter) -- [TransferResult](subgraphs.NeverminedToken.md#transferresult) - -### Functions - -- [getApprovalById](subgraphs.NeverminedToken.md#getapprovalbyid) -- [getApprovals](subgraphs.NeverminedToken.md#getapprovals) -- [getInitializedById](subgraphs.NeverminedToken.md#getinitializedbyid) -- [getInitializeds](subgraphs.NeverminedToken.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NeverminedToken.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NeverminedToken.md#getownershiptransferreds) -- [getRoleAdminChangedById](subgraphs.NeverminedToken.md#getroleadminchangedbyid) -- [getRoleAdminChangeds](subgraphs.NeverminedToken.md#getroleadminchangeds) -- [getRoleGrantedById](subgraphs.NeverminedToken.md#getrolegrantedbyid) -- [getRoleGranteds](subgraphs.NeverminedToken.md#getrolegranteds) -- [getRoleRevokedById](subgraphs.NeverminedToken.md#getrolerevokedbyid) -- [getRoleRevokeds](subgraphs.NeverminedToken.md#getrolerevokeds) -- [getTransferById](subgraphs.NeverminedToken.md#gettransferbyid) -- [getTransfers](subgraphs.NeverminedToken.md#gettransfers) - -## Type Aliases - -### ApprovalArgs - -Ƭ **ApprovalArgs**<`K`\>: { [Property in keyof Pick]: ApprovalFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ApprovalResult`](subgraphs.NeverminedToken.md#approvalresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:63 - -___ - -### ApprovalFields - -Ƭ **ApprovalFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `owner` | ``true`` | -| `spender` | ``true`` | -| `value` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:57 - -___ - -### ApprovalFilter - -Ƭ **ApprovalFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `owner?` | `string` \| ``null`` | -| `owner_contains?` | `string` \| ``null`` | -| `owner_in?` | `string`[] | -| `owner_not?` | `string` \| ``null`` | -| `owner_not_contains?` | `string` \| ``null`` | -| `owner_not_in?` | `string`[] | -| `spender?` | `string` \| ``null`` | -| `spender_contains?` | `string` \| ``null`` | -| `spender_in?` | `string`[] | -| `spender_not?` | `string` \| ``null`` | -| `spender_not_contains?` | `string` \| ``null`` | -| `spender_not_in?` | `string`[] | -| `value?` | `WeiSource` \| ``null`` | -| `value_gt?` | `WeiSource` \| ``null`` | -| `value_gte?` | `WeiSource` \| ``null`` | -| `value_in?` | `WeiSource`[] | -| `value_lt?` | `WeiSource` \| ``null`` | -| `value_lte?` | `WeiSource` \| ``null`` | -| `value_not?` | `WeiSource` \| ``null`` | -| `value_not_in?` | `WeiSource`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:21 - -___ - -### ApprovalResult - -Ƭ **ApprovalResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `owner` | `string` | -| `spender` | `string` | -| `value` | `Wei` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:51 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NeverminedToken.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:94 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:90 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:68 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:86 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NeverminedToken.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:131 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:126 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:99 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:121 - -___ - -### RoleAdminChangedArgs - -Ƭ **RoleAdminChangedArgs**<`K`\>: { [Property in keyof Pick]: RoleAdminChangedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.NeverminedToken.md#roleadminchangedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:176 - -___ - -### RoleAdminChangedFields - -Ƭ **RoleAdminChangedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newAdminRole` | ``true`` | -| `previousAdminRole` | ``true`` | -| `role` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:170 - -___ - -### RoleAdminChangedFilter - -Ƭ **RoleAdminChangedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newAdminRole?` | `string` \| ``null`` | -| `newAdminRole_contains?` | `string` \| ``null`` | -| `newAdminRole_in?` | `string`[] | -| `newAdminRole_not?` | `string` \| ``null`` | -| `newAdminRole_not_contains?` | `string` \| ``null`` | -| `newAdminRole_not_in?` | `string`[] | -| `previousAdminRole?` | `string` \| ``null`` | -| `previousAdminRole_contains?` | `string` \| ``null`` | -| `previousAdminRole_in?` | `string`[] | -| `previousAdminRole_not?` | `string` \| ``null`` | -| `previousAdminRole_not_contains?` | `string` \| ``null`` | -| `previousAdminRole_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:136 - -___ - -### RoleAdminChangedResult - -Ƭ **RoleAdminChangedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newAdminRole` | `string` | -| `previousAdminRole` | `string` | -| `role` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:164 - -___ - -### RoleGrantedArgs - -Ƭ **RoleGrantedArgs**<`K`\>: { [Property in keyof Pick]: RoleGrantedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.NeverminedToken.md#rolegrantedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:221 - -___ - -### RoleGrantedFields - -Ƭ **RoleGrantedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | ``true`` | -| `id` | ``true`` | -| `role` | ``true`` | -| `sender` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:215 - -___ - -### RoleGrantedFilter - -Ƭ **RoleGrantedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account?` | `string` \| ``null`` | -| `account_contains?` | `string` \| ``null`` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| ``null`` | -| `account_not_contains?` | `string` \| ``null`` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| ``null`` | -| `sender_contains?` | `string` \| ``null`` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| ``null`` | -| `sender_not_contains?` | `string` \| ``null`` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:181 - -___ - -### RoleGrantedResult - -Ƭ **RoleGrantedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:209 - -___ - -### RoleRevokedArgs - -Ƭ **RoleRevokedArgs**<`K`\>: { [Property in keyof Pick]: RoleRevokedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.NeverminedToken.md#rolerevokedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:266 - -___ - -### RoleRevokedFields - -Ƭ **RoleRevokedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | ``true`` | -| `id` | ``true`` | -| `role` | ``true`` | -| `sender` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:260 - -___ - -### RoleRevokedFilter - -Ƭ **RoleRevokedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account?` | `string` \| ``null`` | -| `account_contains?` | `string` \| ``null`` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| ``null`` | -| `account_not_contains?` | `string` \| ``null`` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| ``null`` | -| `sender_contains?` | `string` \| ``null`` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| ``null`` | -| `sender_not_contains?` | `string` \| ``null`` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:226 - -___ - -### RoleRevokedResult - -Ƭ **RoleRevokedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:254 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:2 - -___ - -### TransferArgs - -Ƭ **TransferArgs**<`K`\>: { [Property in keyof Pick]: TransferFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`TransferResult`](subgraphs.NeverminedToken.md#transferresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:313 - -___ - -### TransferFields - -Ƭ **TransferFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `from` | ``true`` | -| `id` | ``true`` | -| `to` | ``true`` | -| `value` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:307 - -___ - -### TransferFilter - -Ƭ **TransferFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `from?` | `string` \| ``null`` | -| `from_contains?` | `string` \| ``null`` | -| `from_in?` | `string`[] | -| `from_not?` | `string` \| ``null`` | -| `from_not_contains?` | `string` \| ``null`` | -| `from_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `to?` | `string` \| ``null`` | -| `to_contains?` | `string` \| ``null`` | -| `to_in?` | `string`[] | -| `to_not?` | `string` \| ``null`` | -| `to_not_contains?` | `string` \| ``null`` | -| `to_not_in?` | `string`[] | -| `value?` | `WeiSource` \| ``null`` | -| `value_gt?` | `WeiSource` \| ``null`` | -| `value_gte?` | `WeiSource` \| ``null`` | -| `value_in?` | `WeiSource`[] | -| `value_lt?` | `WeiSource` \| ``null`` | -| `value_lte?` | `WeiSource` \| ``null`` | -| `value_not?` | `WeiSource` \| ``null`` | -| `value_not_in?` | `WeiSource`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:271 - -___ - -### TransferResult - -Ƭ **TransferResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `from` | `string` | -| `id` | `string` | -| `to` | `string` | -| `value` | `Wei` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:301 - -## Functions - -### getApprovalById - -▸ **getApprovalById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ApprovalResult`](subgraphs.NeverminedToken.md#approvalresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ApprovalResult`](subgraphs.NeverminedToken.md#approvalresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedToken.md#singlequeryoptions) | -| `args` | [`ApprovalArgs`](subgraphs.NeverminedToken.md#approvalargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ApprovalResult`](subgraphs.NeverminedToken.md#approvalresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:66 - -___ - -### getApprovals - -▸ **getApprovals**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ApprovalResult`](subgraphs.NeverminedToken.md#approvalresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`ApprovalResult`](subgraphs.NeverminedToken.md#approvalresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedToken.md#multiqueryoptions)<[`ApprovalFilter`](subgraphs.NeverminedToken.md#approvalfilter), [`ApprovalResult`](subgraphs.NeverminedToken.md#approvalresult)\> | -| `args` | [`ApprovalArgs`](subgraphs.NeverminedToken.md#approvalargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ApprovalResult`](subgraphs.NeverminedToken.md#approvalresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:67 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NeverminedToken.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NeverminedToken.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedToken.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NeverminedToken.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NeverminedToken.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:97 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NeverminedToken.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NeverminedToken.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedToken.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NeverminedToken.md#initializedfilter), [`InitializedResult`](subgraphs.NeverminedToken.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NeverminedToken.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NeverminedToken.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:98 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NeverminedToken.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NeverminedToken.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedToken.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NeverminedToken.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NeverminedToken.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:134 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NeverminedToken.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NeverminedToken.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedToken.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NeverminedToken.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NeverminedToken.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NeverminedToken.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NeverminedToken.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:135 - -___ - -### getRoleAdminChangedById - -▸ **getRoleAdminChangedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NeverminedToken.md#roleadminchangedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.NeverminedToken.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedToken.md#singlequeryoptions) | -| `args` | [`RoleAdminChangedArgs`](subgraphs.NeverminedToken.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NeverminedToken.md#roleadminchangedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:179 - -___ - -### getRoleAdminChangeds - -▸ **getRoleAdminChangeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NeverminedToken.md#roleadminchangedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.NeverminedToken.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedToken.md#multiqueryoptions)<[`RoleAdminChangedFilter`](subgraphs.NeverminedToken.md#roleadminchangedfilter), [`RoleAdminChangedResult`](subgraphs.NeverminedToken.md#roleadminchangedresult)\> | -| `args` | [`RoleAdminChangedArgs`](subgraphs.NeverminedToken.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NeverminedToken.md#roleadminchangedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:180 - -___ - -### getRoleGrantedById - -▸ **getRoleGrantedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NeverminedToken.md#rolegrantedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.NeverminedToken.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedToken.md#singlequeryoptions) | -| `args` | [`RoleGrantedArgs`](subgraphs.NeverminedToken.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NeverminedToken.md#rolegrantedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:224 - -___ - -### getRoleGranteds - -▸ **getRoleGranteds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NeverminedToken.md#rolegrantedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.NeverminedToken.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedToken.md#multiqueryoptions)<[`RoleGrantedFilter`](subgraphs.NeverminedToken.md#rolegrantedfilter), [`RoleGrantedResult`](subgraphs.NeverminedToken.md#rolegrantedresult)\> | -| `args` | [`RoleGrantedArgs`](subgraphs.NeverminedToken.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NeverminedToken.md#rolegrantedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:225 - -___ - -### getRoleRevokedById - -▸ **getRoleRevokedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NeverminedToken.md#rolerevokedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.NeverminedToken.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedToken.md#singlequeryoptions) | -| `args` | [`RoleRevokedArgs`](subgraphs.NeverminedToken.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NeverminedToken.md#rolerevokedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:269 - -___ - -### getRoleRevokeds - -▸ **getRoleRevokeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NeverminedToken.md#rolerevokedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.NeverminedToken.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedToken.md#multiqueryoptions)<[`RoleRevokedFilter`](subgraphs.NeverminedToken.md#rolerevokedfilter), [`RoleRevokedResult`](subgraphs.NeverminedToken.md#rolerevokedresult)\> | -| `args` | [`RoleRevokedArgs`](subgraphs.NeverminedToken.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NeverminedToken.md#rolerevokedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:270 - -___ - -### getTransferById - -▸ **getTransferById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`TransferResult`](subgraphs.NeverminedToken.md#transferresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`TransferResult`](subgraphs.NeverminedToken.md#transferresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedToken.md#singlequeryoptions) | -| `args` | [`TransferArgs`](subgraphs.NeverminedToken.md#transferargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`TransferResult`](subgraphs.NeverminedToken.md#transferresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:316 - -___ - -### getTransfers - -▸ **getTransfers**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`TransferResult`](subgraphs.NeverminedToken.md#transferresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`TransferResult`](subgraphs.NeverminedToken.md#transferresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedToken.md#multiqueryoptions)<[`TransferFilter`](subgraphs.NeverminedToken.md#transferfilter), [`TransferResult`](subgraphs.NeverminedToken.md#transferresult)\> | -| `args` | [`TransferArgs`](subgraphs.NeverminedToken.md#transferargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`TransferResult`](subgraphs.NeverminedToken.md#transferresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:317 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.RewardsDistributor.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.RewardsDistributor.md deleted file mode 100644 index 9e61a6e09f..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.RewardsDistributor.md +++ /dev/null @@ -1,202 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / RewardsDistributor - -# Namespace: RewardsDistributor - -[subgraphs](subgraphs.md).RewardsDistributor - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.RewardsDistributor.md#initializedargs) -- [InitializedFields](subgraphs.RewardsDistributor.md#initializedfields) -- [InitializedFilter](subgraphs.RewardsDistributor.md#initializedfilter) -- [InitializedResult](subgraphs.RewardsDistributor.md#initializedresult) -- [MultiQueryOptions](subgraphs.RewardsDistributor.md#multiqueryoptions) -- [SingleQueryOptions](subgraphs.RewardsDistributor.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.RewardsDistributor.md#getinitializedbyid) -- [getInitializeds](subgraphs.RewardsDistributor.md#getinitializeds) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.RewardsDistributor.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/RewardsDistributor.d.ts:46 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/RewardsDistributor.d.ts:42 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/RewardsDistributor.d.ts:20 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/RewardsDistributor.d.ts:38 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/RewardsDistributor.d.ts:9 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/RewardsDistributor.d.ts:1 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.RewardsDistributor.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.RewardsDistributor.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.RewardsDistributor.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.RewardsDistributor.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.RewardsDistributor.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/RewardsDistributor.d.ts:49 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.RewardsDistributor.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.RewardsDistributor.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.RewardsDistributor.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.RewardsDistributor.md#initializedfilter), [`InitializedResult`](subgraphs.RewardsDistributor.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.RewardsDistributor.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.RewardsDistributor.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/RewardsDistributor.d.ts:50 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.SignCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.SignCondition.md deleted file mode 100644 index 728e073283..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.SignCondition.md +++ /dev/null @@ -1,351 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / SignCondition - -# Namespace: SignCondition - -[subgraphs](subgraphs.md).SignCondition - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.SignCondition.md#initializedargs) -- [InitializedFields](subgraphs.SignCondition.md#initializedfields) -- [InitializedFilter](subgraphs.SignCondition.md#initializedfilter) -- [InitializedResult](subgraphs.SignCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.SignCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.SignCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.SignCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.SignCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.SignCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.SignCondition.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.SignCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.SignCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.SignCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.SignCondition.md#getownershiptransferreds) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.SignCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:46 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:42 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:20 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:38 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:9 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.SignCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:83 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:78 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:51 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:73 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:1 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.SignCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.SignCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.SignCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.SignCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.SignCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:49 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.SignCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.SignCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.SignCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.SignCondition.md#initializedfilter), [`InitializedResult`](subgraphs.SignCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.SignCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.SignCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:50 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.SignCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.SignCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.SignCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.SignCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.SignCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:86 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.SignCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.SignCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.SignCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.SignCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.SignCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.SignCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.SignCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:87 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.StandardRoyalties.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.StandardRoyalties.md deleted file mode 100644 index 69b4e0942f..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.StandardRoyalties.md +++ /dev/null @@ -1,202 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / StandardRoyalties - -# Namespace: StandardRoyalties - -[subgraphs](subgraphs.md).StandardRoyalties - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.StandardRoyalties.md#initializedargs) -- [InitializedFields](subgraphs.StandardRoyalties.md#initializedfields) -- [InitializedFilter](subgraphs.StandardRoyalties.md#initializedfilter) -- [InitializedResult](subgraphs.StandardRoyalties.md#initializedresult) -- [MultiQueryOptions](subgraphs.StandardRoyalties.md#multiqueryoptions) -- [SingleQueryOptions](subgraphs.StandardRoyalties.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.StandardRoyalties.md#getinitializedbyid) -- [getInitializeds](subgraphs.StandardRoyalties.md#getinitializeds) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.StandardRoyalties.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/StandardRoyalties.d.ts:46 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/StandardRoyalties.d.ts:42 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/StandardRoyalties.d.ts:20 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/StandardRoyalties.d.ts:38 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/StandardRoyalties.d.ts:9 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/StandardRoyalties.d.ts:1 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.StandardRoyalties.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.StandardRoyalties.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.StandardRoyalties.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.StandardRoyalties.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.StandardRoyalties.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/StandardRoyalties.d.ts:49 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.StandardRoyalties.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.StandardRoyalties.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.StandardRoyalties.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.StandardRoyalties.md#initializedfilter), [`InitializedResult`](subgraphs.StandardRoyalties.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.StandardRoyalties.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.StandardRoyalties.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/StandardRoyalties.d.ts:50 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.TemplateStoreManager.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.TemplateStoreManager.md deleted file mode 100644 index 272831bda4..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.TemplateStoreManager.md +++ /dev/null @@ -1,351 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / TemplateStoreManager - -# Namespace: TemplateStoreManager - -[subgraphs](subgraphs.md).TemplateStoreManager - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.TemplateStoreManager.md#initializedargs) -- [InitializedFields](subgraphs.TemplateStoreManager.md#initializedfields) -- [InitializedFilter](subgraphs.TemplateStoreManager.md#initializedfilter) -- [InitializedResult](subgraphs.TemplateStoreManager.md#initializedresult) -- [MultiQueryOptions](subgraphs.TemplateStoreManager.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.TemplateStoreManager.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.TemplateStoreManager.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.TemplateStoreManager.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.TemplateStoreManager.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.TemplateStoreManager.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.TemplateStoreManager.md#getinitializedbyid) -- [getInitializeds](subgraphs.TemplateStoreManager.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.TemplateStoreManager.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.TemplateStoreManager.md#getownershiptransferreds) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.TemplateStoreManager.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:46 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:42 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:20 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:38 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:9 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TemplateStoreManager.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:83 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:78 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:51 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:73 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:1 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.TemplateStoreManager.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.TemplateStoreManager.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TemplateStoreManager.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.TemplateStoreManager.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.TemplateStoreManager.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:49 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.TemplateStoreManager.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.TemplateStoreManager.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TemplateStoreManager.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.TemplateStoreManager.md#initializedfilter), [`InitializedResult`](subgraphs.TemplateStoreManager.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.TemplateStoreManager.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.TemplateStoreManager.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:50 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TemplateStoreManager.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TemplateStoreManager.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TemplateStoreManager.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.TemplateStoreManager.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TemplateStoreManager.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:86 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TemplateStoreManager.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TemplateStoreManager.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TemplateStoreManager.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.TemplateStoreManager.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.TemplateStoreManager.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.TemplateStoreManager.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TemplateStoreManager.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:87 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.ThresholdCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.ThresholdCondition.md deleted file mode 100644 index a446c452bb..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.ThresholdCondition.md +++ /dev/null @@ -1,351 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / ThresholdCondition - -# Namespace: ThresholdCondition - -[subgraphs](subgraphs.md).ThresholdCondition - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.ThresholdCondition.md#initializedargs) -- [InitializedFields](subgraphs.ThresholdCondition.md#initializedfields) -- [InitializedFilter](subgraphs.ThresholdCondition.md#initializedfilter) -- [InitializedResult](subgraphs.ThresholdCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.ThresholdCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.ThresholdCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.ThresholdCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.ThresholdCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.ThresholdCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.ThresholdCondition.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.ThresholdCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.ThresholdCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.ThresholdCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.ThresholdCondition.md#getownershiptransferreds) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.ThresholdCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:46 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:42 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:20 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:38 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:9 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.ThresholdCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:83 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:78 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:51 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:73 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:1 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.ThresholdCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.ThresholdCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ThresholdCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.ThresholdCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.ThresholdCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:49 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.ThresholdCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.ThresholdCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ThresholdCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.ThresholdCondition.md#initializedfilter), [`InitializedResult`](subgraphs.ThresholdCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.ThresholdCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.ThresholdCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:50 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ThresholdCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.ThresholdCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ThresholdCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.ThresholdCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ThresholdCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:86 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ThresholdCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.ThresholdCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ThresholdCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.ThresholdCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.ThresholdCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.ThresholdCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ThresholdCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:87 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.TransferDIDOwnershipCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.TransferDIDOwnershipCondition.md deleted file mode 100644 index 29e6944a19..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.TransferDIDOwnershipCondition.md +++ /dev/null @@ -1,516 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / TransferDIDOwnershipCondition - -# Namespace: TransferDIDOwnershipCondition - -[subgraphs](subgraphs.md).TransferDIDOwnershipCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.TransferDIDOwnershipCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.TransferDIDOwnershipCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.TransferDIDOwnershipCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.TransferDIDOwnershipCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.TransferDIDOwnershipCondition.md#initializedargs) -- [InitializedFields](subgraphs.TransferDIDOwnershipCondition.md#initializedfields) -- [InitializedFilter](subgraphs.TransferDIDOwnershipCondition.md#initializedfilter) -- [InitializedResult](subgraphs.TransferDIDOwnershipCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.TransferDIDOwnershipCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.TransferDIDOwnershipCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.TransferDIDOwnershipCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.TransferDIDOwnershipCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.TransferDIDOwnershipCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.TransferDIDOwnershipCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.TransferDIDOwnershipCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.TransferDIDOwnershipCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:68 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | ``true`` | -| `_conditionId` | ``true`` | -| `_did` | ``true`` | -| `_receiver` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:61 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_receiver?` | `string` \| ``null`` | -| `_receiver_contains?` | `string` \| ``null`` | -| `_receiver_in?` | `string`[] | -| `_receiver_not?` | `string` \| ``null`` | -| `_receiver_not_contains?` | `string` \| ``null`` | -| `_receiver_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:20 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | `string` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `_receiver` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:54 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.TransferDIDOwnershipCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:99 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:95 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:73 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:91 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:9 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:136 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:131 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:104 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:126 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:1 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferDIDOwnershipCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:71 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferDIDOwnershipCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:72 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferDIDOwnershipCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.TransferDIDOwnershipCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferDIDOwnershipCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.TransferDIDOwnershipCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferDIDOwnershipCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:102 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferDIDOwnershipCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.TransferDIDOwnershipCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferDIDOwnershipCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.TransferDIDOwnershipCondition.md#initializedfilter), [`InitializedResult`](subgraphs.TransferDIDOwnershipCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.TransferDIDOwnershipCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferDIDOwnershipCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:103 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferDIDOwnershipCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:139 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferDIDOwnershipCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:140 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.TransferNFT721Condition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.TransferNFT721Condition.md deleted file mode 100644 index c5036c7080..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.TransferNFT721Condition.md +++ /dev/null @@ -1,1005 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / TransferNFT721Condition - -# Namespace: TransferNFT721Condition - -[subgraphs](subgraphs.md).TransferNFT721Condition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.TransferNFT721Condition.md#fulfilledargs) -- [FulfilledFields](subgraphs.TransferNFT721Condition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.TransferNFT721Condition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.TransferNFT721Condition.md#fulfilledresult) -- [InitializedArgs](subgraphs.TransferNFT721Condition.md#initializedargs) -- [InitializedFields](subgraphs.TransferNFT721Condition.md#initializedfields) -- [InitializedFilter](subgraphs.TransferNFT721Condition.md#initializedfilter) -- [InitializedResult](subgraphs.TransferNFT721Condition.md#initializedresult) -- [MultiQueryOptions](subgraphs.TransferNFT721Condition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.TransferNFT721Condition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.TransferNFT721Condition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.TransferNFT721Condition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.TransferNFT721Condition.md#ownershiptransferredresult) -- [RoleAdminChangedArgs](subgraphs.TransferNFT721Condition.md#roleadminchangedargs) -- [RoleAdminChangedFields](subgraphs.TransferNFT721Condition.md#roleadminchangedfields) -- [RoleAdminChangedFilter](subgraphs.TransferNFT721Condition.md#roleadminchangedfilter) -- [RoleAdminChangedResult](subgraphs.TransferNFT721Condition.md#roleadminchangedresult) -- [RoleGrantedArgs](subgraphs.TransferNFT721Condition.md#rolegrantedargs) -- [RoleGrantedFields](subgraphs.TransferNFT721Condition.md#rolegrantedfields) -- [RoleGrantedFilter](subgraphs.TransferNFT721Condition.md#rolegrantedfilter) -- [RoleGrantedResult](subgraphs.TransferNFT721Condition.md#rolegrantedresult) -- [RoleRevokedArgs](subgraphs.TransferNFT721Condition.md#rolerevokedargs) -- [RoleRevokedFields](subgraphs.TransferNFT721Condition.md#rolerevokedfields) -- [RoleRevokedFilter](subgraphs.TransferNFT721Condition.md#rolerevokedfilter) -- [RoleRevokedResult](subgraphs.TransferNFT721Condition.md#rolerevokedresult) -- [SingleQueryOptions](subgraphs.TransferNFT721Condition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.TransferNFT721Condition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.TransferNFT721Condition.md#getfulfilleds) -- [getInitializedById](subgraphs.TransferNFT721Condition.md#getinitializedbyid) -- [getInitializeds](subgraphs.TransferNFT721Condition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.TransferNFT721Condition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.TransferNFT721Condition.md#getownershiptransferreds) -- [getRoleAdminChangedById](subgraphs.TransferNFT721Condition.md#getroleadminchangedbyid) -- [getRoleAdminChangeds](subgraphs.TransferNFT721Condition.md#getroleadminchangeds) -- [getRoleGrantedById](subgraphs.TransferNFT721Condition.md#getrolegrantedbyid) -- [getRoleGranteds](subgraphs.TransferNFT721Condition.md#getrolegranteds) -- [getRoleRevokedById](subgraphs.TransferNFT721Condition.md#getrolerevokedbyid) -- [getRoleRevokeds](subgraphs.TransferNFT721Condition.md#getrolerevokeds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.TransferNFT721Condition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:87 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | ``true`` | -| `_amount` | ``true`` | -| `_conditionId` | ``true`` | -| `_contract` | ``true`` | -| `_did` | ``true`` | -| `_receiver` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:78 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_amount?` | `WeiSource` \| ``null`` | -| `_amount_gt?` | `WeiSource` \| ``null`` | -| `_amount_gte?` | `WeiSource` \| ``null`` | -| `_amount_in?` | `WeiSource`[] | -| `_amount_lt?` | `WeiSource` \| ``null`` | -| `_amount_lte?` | `WeiSource` \| ``null`` | -| `_amount_not?` | `WeiSource` \| ``null`` | -| `_amount_not_in?` | `WeiSource`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_contract?` | `string` \| ``null`` | -| `_contract_contains?` | `string` \| ``null`` | -| `_contract_in?` | `string`[] | -| `_contract_not?` | `string` \| ``null`` | -| `_contract_not_contains?` | `string` \| ``null`` | -| `_contract_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_receiver?` | `string` \| ``null`` | -| `_receiver_contains?` | `string` \| ``null`` | -| `_receiver_in?` | `string`[] | -| `_receiver_not?` | `string` \| ``null`` | -| `_receiver_not_contains?` | `string` \| ``null`` | -| `_receiver_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:21 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | `string` | -| `_amount` | `Wei` | -| `_conditionId` | `string` | -| `_contract` | `string` | -| `_did` | `string` | -| `_receiver` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:69 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.TransferNFT721Condition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:118 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:114 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:92 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:110 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TransferNFT721Condition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:155 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:150 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:123 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:145 - -___ - -### RoleAdminChangedArgs - -Ƭ **RoleAdminChangedArgs**<`K`\>: { [Property in keyof Pick]: RoleAdminChangedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.TransferNFT721Condition.md#roleadminchangedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:200 - -___ - -### RoleAdminChangedFields - -Ƭ **RoleAdminChangedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newAdminRole` | ``true`` | -| `previousAdminRole` | ``true`` | -| `role` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:194 - -___ - -### RoleAdminChangedFilter - -Ƭ **RoleAdminChangedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newAdminRole?` | `string` \| ``null`` | -| `newAdminRole_contains?` | `string` \| ``null`` | -| `newAdminRole_in?` | `string`[] | -| `newAdminRole_not?` | `string` \| ``null`` | -| `newAdminRole_not_contains?` | `string` \| ``null`` | -| `newAdminRole_not_in?` | `string`[] | -| `previousAdminRole?` | `string` \| ``null`` | -| `previousAdminRole_contains?` | `string` \| ``null`` | -| `previousAdminRole_in?` | `string`[] | -| `previousAdminRole_not?` | `string` \| ``null`` | -| `previousAdminRole_not_contains?` | `string` \| ``null`` | -| `previousAdminRole_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:160 - -___ - -### RoleAdminChangedResult - -Ƭ **RoleAdminChangedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newAdminRole` | `string` | -| `previousAdminRole` | `string` | -| `role` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:188 - -___ - -### RoleGrantedArgs - -Ƭ **RoleGrantedArgs**<`K`\>: { [Property in keyof Pick]: RoleGrantedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.TransferNFT721Condition.md#rolegrantedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:245 - -___ - -### RoleGrantedFields - -Ƭ **RoleGrantedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | ``true`` | -| `id` | ``true`` | -| `role` | ``true`` | -| `sender` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:239 - -___ - -### RoleGrantedFilter - -Ƭ **RoleGrantedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account?` | `string` \| ``null`` | -| `account_contains?` | `string` \| ``null`` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| ``null`` | -| `account_not_contains?` | `string` \| ``null`` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| ``null`` | -| `sender_contains?` | `string` \| ``null`` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| ``null`` | -| `sender_not_contains?` | `string` \| ``null`` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:205 - -___ - -### RoleGrantedResult - -Ƭ **RoleGrantedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:233 - -___ - -### RoleRevokedArgs - -Ƭ **RoleRevokedArgs**<`K`\>: { [Property in keyof Pick]: RoleRevokedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.TransferNFT721Condition.md#rolerevokedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:290 - -___ - -### RoleRevokedFields - -Ƭ **RoleRevokedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | ``true`` | -| `id` | ``true`` | -| `role` | ``true`` | -| `sender` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:284 - -___ - -### RoleRevokedFilter - -Ƭ **RoleRevokedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account?` | `string` \| ``null`` | -| `account_contains?` | `string` \| ``null`` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| ``null`` | -| `account_not_contains?` | `string` \| ``null`` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| ``null`` | -| `sender_contains?` | `string` \| ``null`` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| ``null`` | -| `sender_not_contains?` | `string` \| ``null`` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:250 - -___ - -### RoleRevokedResult - -Ƭ **RoleRevokedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:278 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferNFT721Condition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.TransferNFT721Condition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFT721Condition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.TransferNFT721Condition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferNFT721Condition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:90 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferNFT721Condition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.TransferNFT721Condition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFT721Condition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.TransferNFT721Condition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.TransferNFT721Condition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.TransferNFT721Condition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferNFT721Condition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:91 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferNFT721Condition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.TransferNFT721Condition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFT721Condition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.TransferNFT721Condition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferNFT721Condition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:121 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferNFT721Condition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.TransferNFT721Condition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFT721Condition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.TransferNFT721Condition.md#initializedfilter), [`InitializedResult`](subgraphs.TransferNFT721Condition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.TransferNFT721Condition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferNFT721Condition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:122 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferNFT721Condition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TransferNFT721Condition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFT721Condition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.TransferNFT721Condition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferNFT721Condition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:158 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferNFT721Condition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TransferNFT721Condition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFT721Condition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.TransferNFT721Condition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.TransferNFT721Condition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.TransferNFT721Condition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferNFT721Condition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:159 - -___ - -### getRoleAdminChangedById - -▸ **getRoleAdminChangedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.TransferNFT721Condition.md#roleadminchangedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.TransferNFT721Condition.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFT721Condition.md#singlequeryoptions) | -| `args` | [`RoleAdminChangedArgs`](subgraphs.TransferNFT721Condition.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.TransferNFT721Condition.md#roleadminchangedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:203 - -___ - -### getRoleAdminChangeds - -▸ **getRoleAdminChangeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.TransferNFT721Condition.md#roleadminchangedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.TransferNFT721Condition.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFT721Condition.md#multiqueryoptions)<[`RoleAdminChangedFilter`](subgraphs.TransferNFT721Condition.md#roleadminchangedfilter), [`RoleAdminChangedResult`](subgraphs.TransferNFT721Condition.md#roleadminchangedresult)\> | -| `args` | [`RoleAdminChangedArgs`](subgraphs.TransferNFT721Condition.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.TransferNFT721Condition.md#roleadminchangedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:204 - -___ - -### getRoleGrantedById - -▸ **getRoleGrantedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.TransferNFT721Condition.md#rolegrantedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.TransferNFT721Condition.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFT721Condition.md#singlequeryoptions) | -| `args` | [`RoleGrantedArgs`](subgraphs.TransferNFT721Condition.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.TransferNFT721Condition.md#rolegrantedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:248 - -___ - -### getRoleGranteds - -▸ **getRoleGranteds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.TransferNFT721Condition.md#rolegrantedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.TransferNFT721Condition.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFT721Condition.md#multiqueryoptions)<[`RoleGrantedFilter`](subgraphs.TransferNFT721Condition.md#rolegrantedfilter), [`RoleGrantedResult`](subgraphs.TransferNFT721Condition.md#rolegrantedresult)\> | -| `args` | [`RoleGrantedArgs`](subgraphs.TransferNFT721Condition.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.TransferNFT721Condition.md#rolegrantedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:249 - -___ - -### getRoleRevokedById - -▸ **getRoleRevokedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.TransferNFT721Condition.md#rolerevokedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.TransferNFT721Condition.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFT721Condition.md#singlequeryoptions) | -| `args` | [`RoleRevokedArgs`](subgraphs.TransferNFT721Condition.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.TransferNFT721Condition.md#rolerevokedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:293 - -___ - -### getRoleRevokeds - -▸ **getRoleRevokeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.TransferNFT721Condition.md#rolerevokedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.TransferNFT721Condition.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFT721Condition.md#multiqueryoptions)<[`RoleRevokedFilter`](subgraphs.TransferNFT721Condition.md#rolerevokedfilter), [`RoleRevokedResult`](subgraphs.TransferNFT721Condition.md#rolerevokedresult)\> | -| `args` | [`RoleRevokedArgs`](subgraphs.TransferNFT721Condition.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.TransferNFT721Condition.md#rolerevokedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:294 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.TransferNFTCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.TransferNFTCondition.md deleted file mode 100644 index 81a4761853..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.TransferNFTCondition.md +++ /dev/null @@ -1,1005 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / TransferNFTCondition - -# Namespace: TransferNFTCondition - -[subgraphs](subgraphs.md).TransferNFTCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.TransferNFTCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.TransferNFTCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.TransferNFTCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.TransferNFTCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.TransferNFTCondition.md#initializedargs) -- [InitializedFields](subgraphs.TransferNFTCondition.md#initializedfields) -- [InitializedFilter](subgraphs.TransferNFTCondition.md#initializedfilter) -- [InitializedResult](subgraphs.TransferNFTCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.TransferNFTCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.TransferNFTCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.TransferNFTCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.TransferNFTCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.TransferNFTCondition.md#ownershiptransferredresult) -- [RoleAdminChangedArgs](subgraphs.TransferNFTCondition.md#roleadminchangedargs) -- [RoleAdminChangedFields](subgraphs.TransferNFTCondition.md#roleadminchangedfields) -- [RoleAdminChangedFilter](subgraphs.TransferNFTCondition.md#roleadminchangedfilter) -- [RoleAdminChangedResult](subgraphs.TransferNFTCondition.md#roleadminchangedresult) -- [RoleGrantedArgs](subgraphs.TransferNFTCondition.md#rolegrantedargs) -- [RoleGrantedFields](subgraphs.TransferNFTCondition.md#rolegrantedfields) -- [RoleGrantedFilter](subgraphs.TransferNFTCondition.md#rolegrantedfilter) -- [RoleGrantedResult](subgraphs.TransferNFTCondition.md#rolegrantedresult) -- [RoleRevokedArgs](subgraphs.TransferNFTCondition.md#rolerevokedargs) -- [RoleRevokedFields](subgraphs.TransferNFTCondition.md#rolerevokedfields) -- [RoleRevokedFilter](subgraphs.TransferNFTCondition.md#rolerevokedfilter) -- [RoleRevokedResult](subgraphs.TransferNFTCondition.md#rolerevokedresult) -- [SingleQueryOptions](subgraphs.TransferNFTCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.TransferNFTCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.TransferNFTCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.TransferNFTCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.TransferNFTCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.TransferNFTCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.TransferNFTCondition.md#getownershiptransferreds) -- [getRoleAdminChangedById](subgraphs.TransferNFTCondition.md#getroleadminchangedbyid) -- [getRoleAdminChangeds](subgraphs.TransferNFTCondition.md#getroleadminchangeds) -- [getRoleGrantedById](subgraphs.TransferNFTCondition.md#getrolegrantedbyid) -- [getRoleGranteds](subgraphs.TransferNFTCondition.md#getrolegranteds) -- [getRoleRevokedById](subgraphs.TransferNFTCondition.md#getrolerevokedbyid) -- [getRoleRevokeds](subgraphs.TransferNFTCondition.md#getrolerevokeds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.TransferNFTCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:87 - -___ - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | ``true`` | -| `_amount` | ``true`` | -| `_conditionId` | ``true`` | -| `_contract` | ``true`` | -| `_did` | ``true`` | -| `_receiver` | ``true`` | -| `id` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:78 - -___ - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId?` | `string` \| ``null`` | -| `_agreementId_contains?` | `string` \| ``null`` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| ``null`` | -| `_agreementId_not_contains?` | `string` \| ``null`` | -| `_agreementId_not_in?` | `string`[] | -| `_amount?` | `WeiSource` \| ``null`` | -| `_amount_gt?` | `WeiSource` \| ``null`` | -| `_amount_gte?` | `WeiSource` \| ``null`` | -| `_amount_in?` | `WeiSource`[] | -| `_amount_lt?` | `WeiSource` \| ``null`` | -| `_amount_lte?` | `WeiSource` \| ``null`` | -| `_amount_not?` | `WeiSource` \| ``null`` | -| `_amount_not_in?` | `WeiSource`[] | -| `_conditionId?` | `string` \| ``null`` | -| `_conditionId_contains?` | `string` \| ``null`` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| ``null`` | -| `_conditionId_not_contains?` | `string` \| ``null`` | -| `_conditionId_not_in?` | `string`[] | -| `_contract?` | `string` \| ``null`` | -| `_contract_contains?` | `string` \| ``null`` | -| `_contract_in?` | `string`[] | -| `_contract_not?` | `string` \| ``null`` | -| `_contract_not_contains?` | `string` \| ``null`` | -| `_contract_not_in?` | `string`[] | -| `_did?` | `string` \| ``null`` | -| `_did_contains?` | `string` \| ``null`` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| ``null`` | -| `_did_not_contains?` | `string` \| ``null`` | -| `_did_not_in?` | `string`[] | -| `_receiver?` | `string` \| ``null`` | -| `_receiver_contains?` | `string` \| ``null`` | -| `_receiver_in?` | `string`[] | -| `_receiver_not?` | `string` \| ``null`` | -| `_receiver_not_contains?` | `string` \| ``null`` | -| `_receiver_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:21 - -___ - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `_agreementId` | `string` | -| `_amount` | `Wei` | -| `_conditionId` | `string` | -| `_contract` | `string` | -| `_did` | `string` | -| `_receiver` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:69 - -___ - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.TransferNFTCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:118 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:114 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:92 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:110 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:10 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TransferNFTCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:155 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:150 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:123 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:145 - -___ - -### RoleAdminChangedArgs - -Ƭ **RoleAdminChangedArgs**<`K`\>: { [Property in keyof Pick]: RoleAdminChangedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.TransferNFTCondition.md#roleadminchangedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:200 - -___ - -### RoleAdminChangedFields - -Ƭ **RoleAdminChangedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newAdminRole` | ``true`` | -| `previousAdminRole` | ``true`` | -| `role` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:194 - -___ - -### RoleAdminChangedFilter - -Ƭ **RoleAdminChangedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newAdminRole?` | `string` \| ``null`` | -| `newAdminRole_contains?` | `string` \| ``null`` | -| `newAdminRole_in?` | `string`[] | -| `newAdminRole_not?` | `string` \| ``null`` | -| `newAdminRole_not_contains?` | `string` \| ``null`` | -| `newAdminRole_not_in?` | `string`[] | -| `previousAdminRole?` | `string` \| ``null`` | -| `previousAdminRole_contains?` | `string` \| ``null`` | -| `previousAdminRole_in?` | `string`[] | -| `previousAdminRole_not?` | `string` \| ``null`` | -| `previousAdminRole_not_contains?` | `string` \| ``null`` | -| `previousAdminRole_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:160 - -___ - -### RoleAdminChangedResult - -Ƭ **RoleAdminChangedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newAdminRole` | `string` | -| `previousAdminRole` | `string` | -| `role` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:188 - -___ - -### RoleGrantedArgs - -Ƭ **RoleGrantedArgs**<`K`\>: { [Property in keyof Pick]: RoleGrantedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.TransferNFTCondition.md#rolegrantedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:245 - -___ - -### RoleGrantedFields - -Ƭ **RoleGrantedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | ``true`` | -| `id` | ``true`` | -| `role` | ``true`` | -| `sender` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:239 - -___ - -### RoleGrantedFilter - -Ƭ **RoleGrantedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account?` | `string` \| ``null`` | -| `account_contains?` | `string` \| ``null`` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| ``null`` | -| `account_not_contains?` | `string` \| ``null`` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| ``null`` | -| `sender_contains?` | `string` \| ``null`` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| ``null`` | -| `sender_not_contains?` | `string` \| ``null`` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:205 - -___ - -### RoleGrantedResult - -Ƭ **RoleGrantedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:233 - -___ - -### RoleRevokedArgs - -Ƭ **RoleRevokedArgs**<`K`\>: { [Property in keyof Pick]: RoleRevokedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.TransferNFTCondition.md#rolerevokedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:290 - -___ - -### RoleRevokedFields - -Ƭ **RoleRevokedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | ``true`` | -| `id` | ``true`` | -| `role` | ``true`` | -| `sender` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:284 - -___ - -### RoleRevokedFilter - -Ƭ **RoleRevokedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account?` | `string` \| ``null`` | -| `account_contains?` | `string` \| ``null`` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| ``null`` | -| `account_not_contains?` | `string` \| ``null`` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| ``null`` | -| `role_contains?` | `string` \| ``null`` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| ``null`` | -| `role_not_contains?` | `string` \| ``null`` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| ``null`` | -| `sender_contains?` | `string` \| ``null`` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| ``null`` | -| `sender_not_contains?` | `string` \| ``null`` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:250 - -___ - -### RoleRevokedResult - -Ƭ **RoleRevokedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:278 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferNFTCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.TransferNFTCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFTCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.TransferNFTCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferNFTCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:90 - -___ - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferNFTCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.TransferNFTCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFTCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.TransferNFTCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.TransferNFTCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.TransferNFTCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferNFTCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:91 - -___ - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferNFTCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.TransferNFTCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFTCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.TransferNFTCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferNFTCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:121 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferNFTCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.TransferNFTCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFTCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.TransferNFTCondition.md#initializedfilter), [`InitializedResult`](subgraphs.TransferNFTCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.TransferNFTCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferNFTCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:122 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferNFTCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TransferNFTCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFTCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.TransferNFTCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferNFTCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:158 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferNFTCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TransferNFTCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFTCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.TransferNFTCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.TransferNFTCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.TransferNFTCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferNFTCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:159 - -___ - -### getRoleAdminChangedById - -▸ **getRoleAdminChangedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.TransferNFTCondition.md#roleadminchangedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.TransferNFTCondition.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFTCondition.md#singlequeryoptions) | -| `args` | [`RoleAdminChangedArgs`](subgraphs.TransferNFTCondition.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.TransferNFTCondition.md#roleadminchangedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:203 - -___ - -### getRoleAdminChangeds - -▸ **getRoleAdminChangeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.TransferNFTCondition.md#roleadminchangedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.TransferNFTCondition.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFTCondition.md#multiqueryoptions)<[`RoleAdminChangedFilter`](subgraphs.TransferNFTCondition.md#roleadminchangedfilter), [`RoleAdminChangedResult`](subgraphs.TransferNFTCondition.md#roleadminchangedresult)\> | -| `args` | [`RoleAdminChangedArgs`](subgraphs.TransferNFTCondition.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.TransferNFTCondition.md#roleadminchangedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:204 - -___ - -### getRoleGrantedById - -▸ **getRoleGrantedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.TransferNFTCondition.md#rolegrantedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.TransferNFTCondition.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFTCondition.md#singlequeryoptions) | -| `args` | [`RoleGrantedArgs`](subgraphs.TransferNFTCondition.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.TransferNFTCondition.md#rolegrantedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:248 - -___ - -### getRoleGranteds - -▸ **getRoleGranteds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.TransferNFTCondition.md#rolegrantedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.TransferNFTCondition.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFTCondition.md#multiqueryoptions)<[`RoleGrantedFilter`](subgraphs.TransferNFTCondition.md#rolegrantedfilter), [`RoleGrantedResult`](subgraphs.TransferNFTCondition.md#rolegrantedresult)\> | -| `args` | [`RoleGrantedArgs`](subgraphs.TransferNFTCondition.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.TransferNFTCondition.md#rolegrantedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:249 - -___ - -### getRoleRevokedById - -▸ **getRoleRevokedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.TransferNFTCondition.md#rolerevokedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.TransferNFTCondition.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFTCondition.md#singlequeryoptions) | -| `args` | [`RoleRevokedArgs`](subgraphs.TransferNFTCondition.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.TransferNFTCondition.md#rolerevokedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:293 - -___ - -### getRoleRevokeds - -▸ **getRoleRevokeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.TransferNFTCondition.md#rolerevokedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.TransferNFTCondition.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFTCondition.md#multiqueryoptions)<[`RoleRevokedFilter`](subgraphs.TransferNFTCondition.md#rolerevokedfilter), [`RoleRevokedResult`](subgraphs.TransferNFTCondition.md#rolerevokedresult)\> | -| `args` | [`RoleRevokedArgs`](subgraphs.TransferNFTCondition.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.TransferNFTCondition.md#rolerevokedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:294 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.WhitelistingCondition.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.WhitelistingCondition.md deleted file mode 100644 index a1fa354518..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.WhitelistingCondition.md +++ /dev/null @@ -1,351 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / [subgraphs](subgraphs.md) / WhitelistingCondition - -# Namespace: WhitelistingCondition - -[subgraphs](subgraphs.md).WhitelistingCondition - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.WhitelistingCondition.md#initializedargs) -- [InitializedFields](subgraphs.WhitelistingCondition.md#initializedfields) -- [InitializedFilter](subgraphs.WhitelistingCondition.md#initializedfilter) -- [InitializedResult](subgraphs.WhitelistingCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.WhitelistingCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.WhitelistingCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.WhitelistingCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.WhitelistingCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.WhitelistingCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.WhitelistingCondition.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.WhitelistingCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.WhitelistingCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.WhitelistingCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.WhitelistingCondition.md#getownershiptransferreds) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.WhitelistingCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:46 - -___ - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `version` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:42 - -___ - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| ``null`` | -| `version_gt?` | `number` \| ``null`` | -| `version_gte?` | `number` \| ``null`` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| ``null`` | -| `version_lte?` | `number` \| ``null`` | -| `version_not?` | `number` \| ``null`` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:20 - -___ - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:38 - -___ - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | ``"asc"`` \| ``"desc"`` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:9 - -___ - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.WhitelistingCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:83 - -___ - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | ``true`` | -| `newOwner` | ``true`` | -| `previousOwner` | ``true`` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:78 - -___ - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id?` | `string` \| ``null`` | -| `id_gt?` | `string` \| ``null`` | -| `id_gte?` | `string` \| ``null`` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| ``null`` | -| `id_lte?` | `string` \| ``null`` | -| `id_not?` | `string` \| ``null`` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| ``null`` | -| `newOwner_contains?` | `string` \| ``null`` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| ``null`` | -| `newOwner_not_contains?` | `string` \| ``null`` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| ``null`` | -| `previousOwner_contains?` | `string` \| ``null`` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| ``null`` | -| `previousOwner_not_contains?` | `string` \| ``null`` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:51 - -___ - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:73 - -___ - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:1 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.WhitelistingCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.WhitelistingCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.WhitelistingCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.WhitelistingCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.WhitelistingCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:49 - -___ - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.WhitelistingCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.WhitelistingCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.WhitelistingCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.WhitelistingCondition.md#initializedfilter), [`InitializedResult`](subgraphs.WhitelistingCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.WhitelistingCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.WhitelistingCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:50 - -___ - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.WhitelistingCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.WhitelistingCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.WhitelistingCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.WhitelistingCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.WhitelistingCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:86 - -___ - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.WhitelistingCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.WhitelistingCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.WhitelistingCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.WhitelistingCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.WhitelistingCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.WhitelistingCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.WhitelistingCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:87 diff --git a/docs/nevermined-sdk/api-reference/modules/subgraphs.md b/docs/nevermined-sdk/api-reference/modules/subgraphs.md deleted file mode 100644 index b23a61abe5..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/subgraphs.md +++ /dev/null @@ -1,57 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / subgraphs - -# Namespace: subgraphs - -## Table of contents - -### Namespaces - -- [AaveBorrowCondition](subgraphs.AaveBorrowCondition.md) -- [AaveCollateralDepositCondition](subgraphs.AaveCollateralDepositCondition.md) -- [AaveCollateralWithdrawCondition](subgraphs.AaveCollateralWithdrawCondition.md) -- [AaveCreditTemplate](subgraphs.AaveCreditTemplate.md) -- [AaveRepayCondition](subgraphs.AaveRepayCondition.md) -- [AccessCondition](subgraphs.AccessCondition.md) -- [AccessProofCondition](subgraphs.AccessProofCondition.md) -- [AccessProofTemplate](subgraphs.AccessProofTemplate.md) -- [AccessTemplate](subgraphs.AccessTemplate.md) -- [AgreementStoreManager](subgraphs.AgreementStoreManager.md) -- [ComputeExecutionCondition](subgraphs.ComputeExecutionCondition.md) -- [ConditionStoreManager](subgraphs.ConditionStoreManager.md) -- [DIDRegistry](subgraphs.DIDRegistry.md) -- [DIDSalesTemplate](subgraphs.DIDSalesTemplate.md) -- [Dispenser](subgraphs.Dispenser.md) -- [DistributeNFTCollateralCondition](subgraphs.DistributeNFTCollateralCondition.md) -- [EscrowComputeExecutionTemplate](subgraphs.EscrowComputeExecutionTemplate.md) -- [EscrowPaymentCondition](subgraphs.EscrowPaymentCondition.md) -- [HashLockCondition](subgraphs.HashLockCondition.md) -- [LockPaymentCondition](subgraphs.LockPaymentCondition.md) -- [NFT721AccessProofTemplate](subgraphs.NFT721AccessProofTemplate.md) -- [NFT721AccessSwapTemplate](subgraphs.NFT721AccessSwapTemplate.md) -- [NFT721AccessTemplate](subgraphs.NFT721AccessTemplate.md) -- [NFT721EscrowPaymentCondition](subgraphs.NFT721EscrowPaymentCondition.md) -- [NFT721HolderCondition](subgraphs.NFT721HolderCondition.md) -- [NFT721LockCondition](subgraphs.NFT721LockCondition.md) -- [NFT721SalesTemplate](subgraphs.NFT721SalesTemplate.md) -- [NFT721SalesWithAccessTemplate](subgraphs.NFT721SalesWithAccessTemplate.md) -- [NFT721Upgradeable](subgraphs.NFT721Upgradeable.md) -- [NFTAccessCondition](subgraphs.NFTAccessCondition.md) -- [NFTAccessProofTemplate](subgraphs.NFTAccessProofTemplate.md) -- [NFTAccessSwapTemplate](subgraphs.NFTAccessSwapTemplate.md) -- [NFTAccessTemplate](subgraphs.NFTAccessTemplate.md) -- [NFTEscrowPaymentCondition](subgraphs.NFTEscrowPaymentCondition.md) -- [NFTHolderCondition](subgraphs.NFTHolderCondition.md) -- [NFTLockCondition](subgraphs.NFTLockCondition.md) -- [NFTSalesTemplate](subgraphs.NFTSalesTemplate.md) -- [NFTSalesWithAccessTemplate](subgraphs.NFTSalesWithAccessTemplate.md) -- [NeverminedConfig](subgraphs.NeverminedConfig.md) -- [NeverminedToken](subgraphs.NeverminedToken.md) -- [RewardsDistributor](subgraphs.RewardsDistributor.md) -- [SignCondition](subgraphs.SignCondition.md) -- [StandardRoyalties](subgraphs.StandardRoyalties.md) -- [TemplateStoreManager](subgraphs.TemplateStoreManager.md) -- [ThresholdCondition](subgraphs.ThresholdCondition.md) -- [TransferDIDOwnershipCondition](subgraphs.TransferDIDOwnershipCondition.md) -- [TransferNFT721Condition](subgraphs.TransferNFT721Condition.md) -- [TransferNFTCondition](subgraphs.TransferNFTCondition.md) -- [WhitelistingCondition](subgraphs.WhitelistingCondition.md) diff --git a/docs/nevermined-sdk/api-reference/modules/templates.md b/docs/nevermined-sdk/api-reference/modules/templates.md deleted file mode 100644 index ade3bed679..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/templates.md +++ /dev/null @@ -1,47 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / templates - -# Namespace: templates - -## Table of contents - -### References - -- [AgreementTemplate](templates.md#agreementtemplate) - -### Classes - -- [AaveCreditTemplate](../classes/templates.AaveCreditTemplate.md) -- [AccessTemplate](../classes/templates.AccessTemplate.md) -- [BaseTemplate](../classes/templates.BaseTemplate.md) -- [DIDSalesTemplate](../classes/templates.DIDSalesTemplate.md) -- [EscrowComputeExecutionTemplate](../classes/templates.EscrowComputeExecutionTemplate.md) -- [NFT721AccessTemplate](../classes/templates.NFT721AccessTemplate.md) -- [NFT721SalesTemplate](../classes/templates.NFT721SalesTemplate.md) -- [NFTAccessTemplate](../classes/templates.NFTAccessTemplate.md) -- [NFTSalesTemplate](../classes/templates.NFTSalesTemplate.md) - -### Interfaces - -- [AgreementConditionsStatus](../interfaces/templates.AgreementConditionsStatus.md) -- [AgreementInstance](../interfaces/templates.AgreementInstance.md) -- [PaymentData](../interfaces/templates.PaymentData.md) - -### Type Aliases - -- [ParameterType](templates.md#parametertype) - -## References - -### AgreementTemplate - -Re-exports [AgreementTemplate](../classes/AgreementTemplate.md) - -## Type Aliases - -### ParameterType - -Ƭ **ParameterType**: `string` \| `number` \| `number`[] \| [`Account`](../classes/Account.md) \| [`BabyjubPublicKey`](../classes/KeyTransfer.BabyjubPublicKey.md) \| `Service` \| `ServiceType` \| `TxParameters` - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:38](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L38) diff --git a/docs/nevermined-sdk/api-reference/modules/utils.md b/docs/nevermined-sdk/api-reference/modules/utils.md deleted file mode 100644 index 24fe1e4449..0000000000 --- a/docs/nevermined-sdk/api-reference/modules/utils.md +++ /dev/null @@ -1,506 +0,0 @@ -[@nevermined-io/nevermined-sdk-js](../code-reference.md) / utils - -# Namespace: utils - -## Table of contents - -### References - -- [LoggerInstance](utils.md#loggerinstance) - -### Enumerations - -- [LogLevel](../enums/utils.LogLevel.md) -- [OrderProgressStep](../enums/utils.OrderProgressStep.md) - -### Classes - -- [Logger](../classes/utils.Logger.md) -- [SubscribableObserver](../classes/utils.SubscribableObserver.md) -- [SubscribablePromise](../classes/utils.SubscribablePromise.md) - -### Variables - -- [ZeroAddress](utils.md#zeroaddress) - -### Functions - -- [didPrefixed](utils.md#didprefixed) -- [didTransformer](utils.md#didtransformer) -- [didZeroX](utils.md#didzerox) -- [eventToObject](utils.md#eventtoobject) -- [fillConditionsWithDDO](utils.md#fillconditionswithddo) -- [findServiceConditionByName](utils.md#findserviceconditionbyname) -- [generateId](utils.md#generateid) -- [getAssetRewardsFromDDOByService](utils.md#getassetrewardsfromddobyservice) -- [getAssetRewardsFromService](utils.md#getassetrewardsfromservice) -- [getDIDFromService](utils.md#getdidfromservice) -- [getNftAmountFromService](utils.md#getnftamountfromservice) -- [getNftHolderFromService](utils.md#getnftholderfromservice) -- [makeAccounts](utils.md#makeaccounts) -- [makeBuffer](utils.md#makebuffer) -- [noDidPrefixed](utils.md#nodidprefixed) -- [noZeroX](utils.md#nozerox) -- [objectPromiseAll](utils.md#objectpromiseall) -- [setAssetRewardsFromDDOByService](utils.md#setassetrewardsfromddobyservice) -- [setNFTRewardsFromDDOByService](utils.md#setnftrewardsfromddobyservice) -- [zeroX](utils.md#zerox) -- [zeroXTransformer](utils.md#zeroxtransformer) - -## References - -### LoggerInstance - -Renames and re-exports [Logger](../code-reference.md#logger) - -## Variables - -### ZeroAddress - -• `Const` **ZeroAddress**: ``"0x0000000000000000000000000000000000000000"`` - -#### Defined in - -[src/utils/ConversionTypeHelpers.ts:53](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/ConversionTypeHelpers.ts#L53) - -## Functions - -### didPrefixed - -▸ **didPrefixed**(`input`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/ConversionTypeHelpers.ts:17](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/ConversionTypeHelpers.ts#L17) - -___ - -### didTransformer - -▸ **didTransformer**(`input?`, `prefixOutput`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `input` | `string` | `''` | -| `prefixOutput` | `boolean` | `undefined` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/ConversionTypeHelpers.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/ConversionTypeHelpers.ts#L20) - -___ - -### didZeroX - -▸ **didZeroX**(`input`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/ConversionTypeHelpers.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/ConversionTypeHelpers.ts#L30) - -___ - -### eventToObject - -▸ **eventToObject**(`event`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `any` | - -#### Returns - -`any` - -#### Defined in - -[src/utils/Events.ts:1](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Events.ts#L1) - -___ - -### fillConditionsWithDDO - -▸ **fillConditionsWithDDO**(`conditions`, `ddo`, `assetRewards?`, `erc20TokenContract?`, `nftTokenContract?`, `nftHolder?`, `nftAmount?`, `nftTransfer?`, `duration?`): `ServiceAgreementTemplateCondition`[] - -Fill some static parameters that depends on the metadata. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `conditions` | `ServiceAgreementTemplateCondition`[] | `undefined` | Conditions to fill. | -| `ddo` | [`DDO`](../classes/DDO.md) | `undefined` | DDO related to this conditions. | -| `assetRewards` | `default` | `undefined` | Rewards distribution | -| `erc20TokenContract?` | `string` | `undefined` | Number of nfts to handle | -| `nftTokenContract?` | `string` | `undefined` | Number of nfts to handle | -| `nftHolder?` | `string` | `undefined` | - | -| `nftAmount?` | `default` | `undefined` | Number of nfts to handle | -| `nftTransfer` | `boolean` | `false` | - | -| `duration` | `number` | `0` | - | - -#### Returns - -`ServiceAgreementTemplateCondition`[] - -Filled conditions. - -#### Defined in - -[src/utils/DDOHelpers.ts:71](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/DDOHelpers.ts#L71) - -___ - -### findServiceConditionByName - -▸ **findServiceConditionByName**(`service`, `name`): `ServiceAgreementTemplateCondition` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `service` | `ServiceCommon` | -| `name` | `ConditionType` | - -#### Returns - -`ServiceAgreementTemplateCondition` - -#### Defined in - -[src/utils/DDOHelpers.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/DDOHelpers.ts#L100) - -___ - -### generateId - -▸ **generateId**(`length?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `length` | `number` | `64` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/GeneratorHelpers.ts:3](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/GeneratorHelpers.ts#L3) - -___ - -### getAssetRewardsFromDDOByService - -▸ **getAssetRewardsFromDDOByService**(`ddo`, `service`): `AssetRewards` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ddo` | [`DDO`](../classes/DDO.md) | -| `service` | `ServiceType` | - -#### Returns - -`AssetRewards` - -#### Defined in - -[src/utils/DDOHelpers.ts:109](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/DDOHelpers.ts#L109) - -___ - -### getAssetRewardsFromService - -▸ **getAssetRewardsFromService**(`service`): `AssetRewards` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `service` | `ServiceCommon` | - -#### Returns - -`AssetRewards` - -#### Defined in - -[src/utils/DDOHelpers.ts:148](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/DDOHelpers.ts#L148) - -___ - -### getDIDFromService - -▸ **getDIDFromService**(`service`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `service` | `ServiceCommon` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/DDOHelpers.ts:167](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/DDOHelpers.ts#L167) - -___ - -### getNftAmountFromService - -▸ **getNftAmountFromService**(`service`): `BigNumber` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `service` | `ServiceCommon` | - -#### Returns - -`BigNumber` - -#### Defined in - -[src/utils/DDOHelpers.ts:179](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/DDOHelpers.ts#L179) - -___ - -### getNftHolderFromService - -▸ **getNftHolderFromService**(`service`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `service` | `ServiceCommon` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/DDOHelpers.ts:173](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/DDOHelpers.ts#L173) - -___ - -### makeAccounts - -▸ **makeAccounts**(`seedphrase`): `ethers.Wallet`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `seedphrase` | `string` | - -#### Returns - -`ethers.Wallet`[] - -#### Defined in - -[src/utils/MakeAccounts.ts:4](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/MakeAccounts.ts#L4) - -___ - -### makeBuffer - -▸ **makeBuffer**(`a`, `b`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | `any` | -| `b` | `any` | - -#### Returns - -`Buffer` - -#### Defined in - -[src/utils/index.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/index.ts#L12) - -___ - -### noDidPrefixed - -▸ **noDidPrefixed**(`input`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/ConversionTypeHelpers.ts:18](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/ConversionTypeHelpers.ts#L18) - -___ - -### noZeroX - -▸ **noZeroX**(`input`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/ConversionTypeHelpers.ts:5](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/ConversionTypeHelpers.ts#L5) - -___ - -### objectPromiseAll - -▸ **objectPromiseAll**(`obj`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | `Object` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[src/utils/PromiseResolver.ts:11](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/PromiseResolver.ts#L11) - -___ - -### setAssetRewardsFromDDOByService - -▸ **setAssetRewardsFromDDOByService**(`ddo`, `serviceType`, `rewards`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ddo` | [`DDO`](../classes/DDO.md) | -| `serviceType` | `ServiceType` | -| `rewards` | `default` | - -#### Returns - -`void` - -#### Defined in - -[src/utils/DDOHelpers.ts:132](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/DDOHelpers.ts#L132) - -___ - -### setNFTRewardsFromDDOByService - -▸ **setNFTRewardsFromDDOByService**(`ddo`, `serviceType`, `rewards`, `holderAddress`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ddo` | [`DDO`](../classes/DDO.md) | -| `serviceType` | `ServiceType` | -| `rewards` | `default` | -| `holderAddress` | `string` | - -#### Returns - -`void` - -#### Defined in - -[src/utils/DDOHelpers.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/DDOHelpers.ts#L116) - -___ - -### zeroX - -▸ **zeroX**(`input`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/ConversionTypeHelpers.ts:4](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/ConversionTypeHelpers.ts#L4) - -___ - -### zeroXTransformer - -▸ **zeroXTransformer**(`input?`, `zeroOutput`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `input` | `string` | `''` | -| `zeroOutput` | `boolean` | `undefined` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/ConversionTypeHelpers.ts:7](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/ConversionTypeHelpers.ts#L7) diff --git a/docs/nevermined-sdk/compute-example.md b/docs/nevermined-sdk/compute-example.md index be4be43570..5d15d2b7c3 100644 --- a/docs/nevermined-sdk/compute-example.md +++ b/docs/nevermined-sdk/compute-example.md @@ -18,7 +18,7 @@ Before you start with this demo you require: ## Nevermined configuration -The first step to run this example is to define the configuration [options needed](./api-reference/classes/Config.md) to initialize the [Nevermined SDK](./intro.md). +The first step to run this example is to define the configuration [options needed](./api-reference/classes/NeverminedOptions.md)) to initialize the [Nevermined SDK](./intro.md). ```ts const configBase: NeverminedOptions = { diff --git a/docs/nevermined-sdk/example.md b/docs/nevermined-sdk/example.md index da055abd59..a0aa76f841 100644 --- a/docs/nevermined-sdk/example.md +++ b/docs/nevermined-sdk/example.md @@ -13,7 +13,7 @@ Before you start with this demo you require: * The Nevermined artifacts, you can find the script [here](https://github.com/nevermined-io/create-nevermined-react/blob/main/scripts/download-artifacts.sh). To use the script run `./download-artifacts.sh [VERSION OF THE CONTRACT] [NETWORK]` ## Let's start with the app config file -The first file that you need to create is the `config.ts` file which contains all the [options needed](./api-reference/classes/Config.md) to initialize the [Nevermined SDK](./intro.md). +The first file that you need to create is the `config.ts` file which contains all the [options needed](./api-reference/classes/NeverminedOptions.md) to initialize the [Nevermined SDK](./intro.md). ```ts import { NeverminedOptions } from '@nevermined-io/sdk' diff --git a/docusaurus.config.js b/docusaurus.config.js index 483f8f6531..1d4f2f9ccc 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -12,7 +12,7 @@ const config = { 'Nevermined champions open Data and AI to lower the barrier of entry for AI adoption and advancement and opposes the centralization of AI development and training data', url: 'https://docs.nevermined.io', baseUrl: '/', - onBrokenLinks: 'throw', + onBrokenLinks: 'warn', onBrokenMarkdownLinks: 'warn', favicon: 'img/favicon.ico', plugins: ['docusaurus-plugin-sass', './src/plugins/http-support'], diff --git a/package.json b/package.json index 35b6379fd0..5853055458 100644 --- a/package.json +++ b/package.json @@ -18,10 +18,10 @@ "lint:fix": "npm run lint -- --fix" }, "dependencies": { - "@docusaurus/core": "^2.3.1", + "@docusaurus/core": "^2.4.3", "@docusaurus/plugin-google-analytics": "^2.3.1", "@docusaurus/preset-classic": "^2.3.1", - "@docusaurus/theme-classic": "^2.3.1", + "@docusaurus/theme-classic": "^2.4.3", "@docusaurus/theme-common": "^2.3.1", "@docusaurus/theme-search-algolia": "^2.3.1", "@mdx-js/react": "^1.6.22", @@ -33,7 +33,7 @@ "bem-helpers": "^1.1.0", "caniuse-lite": "^1.0.30001591", "clsx": "^1.1.1", - "docusaurus-plugin-sass": "^0.2.2", + "docusaurus-plugin-sass": "^0.2.5", "ethers": "^5.7.1", "jose": "^4.10.0", "prism-react-renderer": "^1.3.3", @@ -45,8 +45,8 @@ "sass": "^1.52.3" }, "devDependencies": { - "@docusaurus/module-type-aliases": "^2.3.1", - "@tsconfig/docusaurus": "^1.0.5", + "@docusaurus/module-type-aliases": "^2.4.3", + "@tsconfig/docusaurus": "^2.0.3", "@typescript-eslint/eslint-plugin": "^5.41.0", "@typescript-eslint/parser": "^5.41.0", "browserify-zlib": "^0.2.0", diff --git a/yarn.lock b/yarn.lock index 931bdb2439..8ab326a159 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1296,9 +1296,9 @@ "@docsearch/css" "3.5.2" algoliasearch "^4.19.1" -"@docusaurus/core@2.4.3", "@docusaurus/core@^2.3.1": +"@docusaurus/core@2.4.3", "@docusaurus/core@^2.4.3": version "2.4.3" - resolved "https://registry.npmjs.org/@docusaurus/core/-/core-2.4.3.tgz" + resolved "https://registry.yarnpkg.com/@docusaurus/core/-/core-2.4.3.tgz#d86624901386fd8164ce4bff9cc7f16fde57f523" integrity sha512-dWH5P7cgeNSIg9ufReX6gaCl/TmrGKD38Orbwuz05WPhAQtFXHd5B8Qym1TiXfvUNvwoYKkAJOJuGe8ou0Z7PA== dependencies: "@babel/core" "^7.18.6" @@ -1414,7 +1414,7 @@ url-loader "^4.1.1" webpack "^5.73.0" -"@docusaurus/module-type-aliases@2.4.3", "@docusaurus/module-type-aliases@^2.3.1": +"@docusaurus/module-type-aliases@2.4.3", "@docusaurus/module-type-aliases@^2.4.3": version "2.4.3" resolved "https://registry.npmjs.org/@docusaurus/module-type-aliases/-/module-type-aliases-2.4.3.tgz" integrity sha512-cwkBkt1UCiduuvEAo7XZY01dJfRn7UR/75mBgOdb1hKknhrabJZ8YH+7savd/y9kLExPyrhe0QwdS9GuzsRRIA== @@ -1570,7 +1570,7 @@ "@types/react" "*" prop-types "^15.6.2" -"@docusaurus/theme-classic@2.4.3", "@docusaurus/theme-classic@^2.3.1": +"@docusaurus/theme-classic@2.4.3", "@docusaurus/theme-classic@^2.4.3": version "2.4.3" resolved "https://registry.npmjs.org/@docusaurus/theme-classic/-/theme-classic-2.4.3.tgz" integrity sha512-QKRAJPSGPfDY2yCiPMIVyr+MqwZCIV2lxNzqbyUW0YkrlmdzzP3WuQJPMGLCjWgQp/5c9kpWMvMxjhpZx1R32Q== @@ -3018,10 +3018,10 @@ resolved "https://registry.npmjs.org/@trysound/sax/-/sax-0.2.0.tgz" integrity sha512-L7z9BgrNEcYyUYtF+HaEfiS5ebkh9jXqbszz7pC0hRBPaatV0XjSD3+eHrpqFemQfgwiFF0QPIarnIihIDn7OA== -"@tsconfig/docusaurus@^1.0.5": - version "1.0.5" - resolved "https://registry.npmjs.org/@tsconfig/docusaurus/-/docusaurus-1.0.5.tgz" - integrity sha512-KM/TuJa9fugo67dTGx+ktIqf3fVc077J6jwHu845Hex4EQf7LABlNonP/mohDKT0cmncdtlYVHHF74xR/YpThg== +"@tsconfig/docusaurus@^2.0.3": + version "2.0.3" + resolved "https://registry.yarnpkg.com/@tsconfig/docusaurus/-/docusaurus-2.0.3.tgz#08a4a65e038a499fc4154ce32b538913d9f3c90d" + integrity sha512-3l1L5PzWVa7l0691TjnsZ0yOIEwG9DziSqu5IPZPlI5Dowi7z42cEym8Y35GHbgHvPcBfNxfrbxm7Cncn4nByQ== "@types/body-parser@*": version "1.19.5" @@ -6208,9 +6208,9 @@ doctrine@^3.0.0: dependencies: esutils "^2.0.2" -docusaurus-plugin-sass@^0.2.2: +docusaurus-plugin-sass@^0.2.5: version "0.2.5" - resolved "https://registry.npmjs.org/docusaurus-plugin-sass/-/docusaurus-plugin-sass-0.2.5.tgz" + resolved "https://registry.yarnpkg.com/docusaurus-plugin-sass/-/docusaurus-plugin-sass-0.2.5.tgz#6bfb8a227ac6265be685dcbc24ba1989e27b8005" integrity sha512-Z+D0fLFUKcFpM+bqSUmqKIU+vO+YF1xoEQh5hoFreg2eMf722+siwXDD+sqtwU8E4MvVpuvsQfaHwODNlxJAEg== dependencies: sass-loader "^10.1.1"